- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
Retrieves the list of instance group resources contained within the specified region.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/instanceGroups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example, |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
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, "items": [ { "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 } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of InstanceGroup resources. |
items[].id |
[Output Only] A unique identifier for this instance group, generated by the server. |
items[].creationTimestamp |
[Output Only] The creation timestamp for this instance group in RFC3339 text format. |
items[].name |
The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].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. |
items[].namedPorts[].name |
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. |
items[].namedPorts[].port |
The port number, which can be a value between 1 and 65535. |
items[].network |
The URL of the network to which all instances in the instance group belong. |
items[].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. |
items[].zone |
[Output Only] The URL of the zone where the instance group is located (for zonal resources). |
items[].selfLink |
[Output Only] The URL for this instance group. The server generates this URL. |
items[].size |
[Output Only] The total number of instances in the instance group. |
items[].region |
[Output Only] The URL of the region where the instance group is located (for regional resources). |
items[].subnetwork |
[Output Only] The URL of the subnetwork to which all instances in the instance group belong. |
items[].kind |
[Output Only] The resource type, which is always |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
kind |
The resource type. |
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.instanceGroups.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.