Method: projects.locations.applications.instances.list

Lists Instances in a given project and location.

HTTP request

GET https://{endpoint}/v1alpha1/{parent=projects/*/locations/*/applications/*}/instances

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent value for ListInstancesRequest.

Query parameters

Parameters
pageSize

integer

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken

string

A token identifying a page of results the server should return.

filter

string

Filtering results.

orderBy

string

Hint for how to order the results.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Message for response to listing Instances.

JSON representation
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
instances[]

object (Instance)

The list of Instance.

nextPageToken

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.