Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.
HTTP request
POST https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/instanceGroups/{resourceId}/listInstances
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
resourceId |
Name of the regional instance group for which we want to list the instances. Authorization requires the following Google IAM permission on the specified resource
|
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 contains data with the following structure:
JSON representation | |
---|---|
{ "instanceState": enum, "portName": string } |
Fields | |
---|---|
instanceState |
Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances. |
portName |
Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances. |
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "instance": string, "status": enum, "namedPorts": [ { "name": string, "port": number } ] } ], "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 InstanceWithNamedPorts resources. |
items[].instance |
[Output Only] The URL of the instance. |
items[].status |
[Output Only] The status of the instance. |
items[].namedPorts[] |
[Output Only] The named ports that belong to 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. |
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.