Method: nodeGroups.get

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
• Authorization Scopes
• IAM Permissions

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	string Project ID for this request.
zone	string The name of the zone for this request.
resourceId	string 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, "kind": string }

Fields
id	string (fixed64 format) [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp	string [Output Only] Creation timestamp in RFC3339 text format.
name	string 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 [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.
description	string An optional description of this resource. Provide this property when you create the resource.
nodeTemplate	string The URL of the node template to which this node group belongs.
zone	string [Output Only] The name of the zone where the node group resides, such as us-central1-a.
selfLink	string [Output Only] Server-defined URL for the resource.
status	enum
size	integer [Output Only] The total number of nodes in the node group.
autoscalingPolicy	object Specifies how autoscaling should behave.
autoscalingPolicy.mode	enum The autoscaling mode.
autoscalingPolicy.minNodes	integer The minimum number of nodes that the group should have.
autoscalingPolicy.maxNodes	integer The maximum number of nodes that the group should have.
maintenancePolicy	enum Specifies how to handle instances when a node in the group undergoes maintenance.
fingerprint	string (bytes format) A base64-encoded string.
kind	string [Output Only] The type of the resource. Always compute#nodeGroup for node group.

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 Google IAM permissions:

• compute.nodeGroups.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.