Returns the specified instance group. Gets a list of available instance groups by making a list()
request.
HTTP request
GET https://www.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instanceGroups/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
The name of the zone where the instance group is located. |
resourceId |
The name of the instance group. Authorization requires the following Google IAM permission on the specified resource
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
InstanceGroups
JSON representation | |
---|---|
{ "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 | |
---|---|
id |
[Output Only] A unique identifier for this instance group, generated by the server. |
creationTimestamp |
[Output Only] The creation timestamp for this instance group in RFC3339 text format. |
name |
The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. |
description |
An optional description of this resource. Provide this property when you create the resource. |
namedPorts[] |
Assigns a name to a port number. For example: 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: Named ports apply to all instances in this instance group. |
namedPorts[].name |
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. |
namedPorts[].port |
The port number, which can be a value between 1 and 65535. |
network |
The URL of the network to which all instances in the instance group belong. |
fingerprint |
[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. |
zone |
[Output Only] The URL of the zone where the instance group is located (for zonal resources). |
selfLink |
[Output Only] The URL for this instance group. The server generates this URL. |
size |
[Output Only] The total number of instances in the instance group. |
region |
[Output Only] The URL of the region where the instance group is located (for regional resources). |
subnetwork |
[Output Only] The URL of the subnetwork to which all instances in the instance group belong. |
kind |
[Output Only] The resource type, which is 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.