Method: instanceGroups.get

Returns the specified instance group. acceleratorTypes.get a list of available instance groups by making a list() request.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instanceGroups/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

The name of the zone where the instance group is located.

resourceId

string

The name of the instance group.

Authorization requires the following Google IAM permission on the specified resource resource_id:

  • compute.instanceGroups.get

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "namedPorts": {
      "name": string,
      "port": number
    },
    "network": string,
    "fingerprint": string,
    "zone": string,
    "selfLink": string,
    "size": number,
    "region": string,
    "subnetwork": string,
    "kind": string
  },
}
Fields
resource

object

resource.id

string (fixed64 format)

[Output Only] A unique identifier for this instance group, generated by the server.

resource.creationTimestamp

string

[Output Only] The creation timestamp for this instance group in RFC3339 text format.

resource.name

string

The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

resource.description

string

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

resource.namedPorts[]

object

Assigns a name to a port number. For example: {name: "http", port: 80}

This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]

Named ports apply to all instances in this instance group.

resource.namedPorts[].name

string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

resource.namedPorts[].port

number

The port number, which can be a value between 1 and 65535.

resource.network

string

The URL of the network to which all instances in the instance group belong.

resource.fingerprint

string (bytes format)

[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

A base64-encoded string.

resource.zone

string

[Output Only] The URL of the zone where the instance group is located (for zonal resources).

resource.selfLink

string

[Output Only] The URL for this instance group. The server generates this URL.

resource.size

number

[Output Only] The total number of instances in the instance group.

resource.region

string

The URL of the region where the instance group is located (for regional resources).

resource.subnetwork

string

The URL of the subnetwork to which all instances in the instance group belong.

resource.kind

string

[Output Only] The resource type, which is always compute#instanceGroup for instance groups.

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 Auth Guide.

Send feedback about...

Compute Engine