- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Returns the specified NodeGroup. globalOperations.get a list of available NodeGroups by making a list()
request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/nodeGroups/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
The name of the zone for this request. |
resourceId |
Name of the node group to return. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "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, "fingerprint": string, "maintenanceWindow": { "startTime": string, "maintenanceDuration": { "seconds": string, "nanos": integer } }, "kind": string } |
Fields | |
---|---|
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: |
fingerprint |
A base64-encoded string. |
maintenanceWindow |
|
maintenanceWindow.startTime |
instances.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 |
kind |
[Output Only] The type of the resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.nodeGroups.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.