Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
nodeGroups

Updates the specified node group.

patch/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}

Path parameters

projectstring required

Project ID for this request.

zonestring required

The name of the zone for this request.

nodeGroupstring required

Name of the NodeGroup resource to update.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

locationHintstring

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 location_hint present in the NodeTemplate.

descriptionstring

An optional description of this resource. Provide this property when you create the resource.

fingerprintstring byte
namestring

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 withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

sizeinteger

Output only. [Output Only] The total number of nodes in the node group.

kindstring

Output only. [Output Only] The type of the resource. Alwayscompute#nodeGroup for node group.

idstring uint64

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

maintenancePolicy'DEFAULT' | 'MAINTENANCE_POLICY_UNSPECIFIED' | 'MIGRATE_WITHIN_NODE_GROUP' | 'RESTART_IN_PLACE'

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT,RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

status'CREATING' | 'DELETING' | 'INVALID' | 'READY'
nodeTemplatestring

URL of the node template to create the node group from.

selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

maintenanceInterval'AS_NEEDED' | 'RECURRENT'

Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED and RECURRENT.

zonestring

Output only. [Output Only] The name of the zone where the node group resides, such as us-central1-a.

Response

Successful response