Retrieves the list of zonal instance group resources contained within the specified zone.
For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
HTTP requestGET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroups
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
string
Project ID for this request.
zone
string
The name of the zone where the instance group is located.
Query parameters ParametersmaxResults
integer (uint32 format)
The maximum number of results per page that should be returned. If the number of available results is larger than maxResults
, Compute Engine returns a nextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are 0
to 500
, inclusive. (Default: 500
)
pageToken
string
Specifies a page token to use. Set pageToken
to the nextPageToken
returned by a previous list request to get the next page of results.
filter
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =
, !=
, >
, <
, <=
, >=
or :
.
For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance
by specifying name != example-instance
.
The :*
comparison can be used to test whether a key has been defined. For example, to find all objects with owner
label use:
labels.owner:*
You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false
to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
To filter on multiple expressions, provide each separate expression within parentheses. For example:
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
By default, each expression is an AND
expression. However, you can include AND
and OR
expressions explicitly. For example:
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
If you want to use a regular expression, use the eq
(equal) or ne
(not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:
fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance", you would use name ne .*instance
.
You cannot combine constraints on multiple fields using regular expressions.
orderBy
string
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 orderBy="creationTimestamp desc"
. This sorts results based on the creationTimestamp
field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Currently, only sorting by name
or creationTimestamp desc
is supported.
returnPartialSuccess
boolean
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Request bodyThe request body must be empty.
Response bodyA list of InstanceGroup resources.
If successful, the response body contains data with the following structure:
JSON representation{ "kind": string, "id": string, "items": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "namedPorts": [ { "name": string, "port": integer } ], "network": string, "fingerprint": string, "zone": string, "selfLink": string, "size": integer, "region": string, "subnetwork": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }Fields
kind
string
[Output Only] The resource type, which is always compute#instanceGroupList
for instance group lists.
id
string
[Output Only] Unique identifier for the resource; defined by the server.
items[]
object
A list of InstanceGroup resources.
items[].kind
string
[Output Only] The resource type, which is always compute#instanceGroup
for instance groups.
items[].id
string (uint64 format)
[Output Only] A unique identifier for this instance group, generated by the server.
items[].creationTimestamp
string
[Output Only] The creation timestamp for this instance group in RFC3339 text format.
items[].name
string
The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
items[].description
string
An optional description of this resource. Provide this property when you create the resource.
items[].namedPorts[]
object
Optional. 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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}]
Named ports apply to all instances in this instance group.
items[].namedPorts[].name
string
The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
items[].namedPorts[].port
integer
The port number, which can be a value between 1 and 65535.
items[].network
string
[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
items[].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.
items[].zone
string
[Output Only] The URL of the zone where the instance group is located (for zonal resources).
items[].selfLink
string
[Output Only] The URL for this instance group. The server generates this URL.
items[].size
integer
[Output Only] The total number of instances in the instance group.
items[].region
string
[Output Only] The URL of the region where the instance group is located (for regional resources).
items[].subnetwork
string
[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
nextPageToken
string
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults
, use the nextPageToken
as a value for the query parameter pageToken
in the next list request. Subsequent list requests will have their own nextPageToken
to continue paging through the results.
selfLink
string
[Output Only] Server-defined URL for this resource.
warning
object
[Output Only] Informational warning message.
warning.code
enum
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE
if there are no results in the response.
warning.message
string
[Output Only] A human-readable description of the warning code.
warning.data[]
object
[Output Only] Metadata about this warning in key: value
format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warning.data[].key
string
[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 scope
and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value
string
[Output Only] A warning data value corresponding to the key.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM PermissionsIn addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.instanceGroups.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4