Resource: NodeGroup
Represents a sole-tenant Node Group resource.
A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "nodeTemplate": string, "zone": string, "selfLink": string, "status": enum, "size": integer, "autoscalingPolicy": { "mode": enum, "minNodes": integer, "maxNodes": integer }, "maintenancePolicy": enum, "locationHint": string, "fingerprint": string, "maintenanceWindow": { "startTime": string, "maintenanceDuration": { "seconds": string, "nanos": integer } }, "shareSettings": { "shareType": enum, "projects": [ string ], "projectMap": { string: { "projectId": string }, ... } }, "maintenanceInterval": enum } |
Fields | |
---|---|
kind |
[Output Only] The type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
description |
An optional description of this resource. Provide this property when you create the resource. |
nodeTemplate |
URL of the node template to create the node group from. |
zone |
[Output Only] The name of the zone where the node group resides, such as us-central1-a. |
selfLink |
[Output Only] Server-defined URL for the resource. |
status |
|
size |
[Output Only] The total number of nodes in the node group. |
autoscalingPolicy |
Specifies how autoscaling should behave. |
autoscalingPolicy.mode |
The autoscaling mode. Set to one of: |
autoscalingPolicy.minNodes |
The minimum number of nodes that the group should have. |
autoscalingPolicy.maxNodes |
The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100. |
maintenancePolicy |
Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: |
locationHint |
An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any locationHint present in the NodeTemplate. |
fingerprint |
A base64-encoded string. |
maintenanceWindow |
|
maintenanceWindow.startTime |
Start time of the window. This must be in UTC format that resolves to one of |
maintenanceWindow.maintenanceDuration |
[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. |
maintenanceWindow.maintenanceDuration.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
maintenanceWindow.maintenanceDuration.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
shareSettings |
Share-settings for the node group |
shareSettings.shareType |
Type of sharing for this shared-reservation |
shareSettings.projects[] |
A nodeGroups.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS. |
shareSettings.projectMap[] |
A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS. |
shareSettings.projectMap[].projectId |
The project ID, should be same as the key of this project config in the parent map. |
maintenanceInterval |
Specifies the frequency of planned maintenance events. The accepted values are: |
Methods |
|
---|---|
|
Adds specified number of nodes to the node group. |
|
Retrieves an aggregated list of node groups. |
|
Deletes the specified NodeGroup resource. |
|
Deletes specified nodes from the node group. |
|
Returns the specified NodeGroup. |
|
Gets the access control policy for a resource. |
|
Creates a NodeGroup resource in the specified project using the data included in the request. |
|
Retrieves a list of node groups available to the specified project. |
|
Lists nodes in the node group. |
|
Updates the specified node group. |
|
Perform maintenance on a subset of nodes in the node group. |
|
Sets the access control policy on the specified resource. |
|
Updates the node template of the node group. |
|
Simulates maintenance event on specified nodes from the node group. |
|
Returns permissions that a caller has on the specified resource. |