RegionInstanceGroups: listInstances

Requires authorization

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.

Request

HTTP request

POST https://www.googleapis.com/compute/beta/projects/project/regions/region/instanceGroups/instanceGroup/listInstances

Parameters

Parameter name Value Description
Path parameters
instanceGroup string Name of the regional instance group for which we want to list the instances.
project string Project ID for this request.
region string Name of the region scoping this request.
Optional query parameters
filter string Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResults unsigned integer 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)
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.
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.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

In the request body, supply data with the following structure:

{
  "instanceState": string,
  "portName": string
}
Property name Value Description Notes
instanceState string Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
portName string 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

If successful, this method returns a response body with the following structure:

{
  "kind": "compute#regionInstanceGroupsListInstances",
  "id": string,
  "items": [
    {
      "instance": string,
      "status": string,
      "namedPorts": [
        {
          "name": string,
          "port": integer
        }
      ]
    }
  ],
  "nextPageToken": string,
  "selfLink": string
}
Property name Value Description Notes
kind string The resource type.
id string [Output Only] Unique identifier for the resource. Defined by the server.
items[] list A list of instances and any named ports that are assigned to those instances.
items[].instance string [Output Only] The URL of the instance.
items[].status string [Output Only] The status of the instance.
items[].namedPorts[] list [Output Only] The named ports that belong to 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.
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.

Send feedback about...

Compute Engine