Method: projects.locations.instances.list

Lists instances.

HTTP request

GET https://financialservices.googleapis.com/v1/{parent=projects/*/locations/*}/instances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.

Authorization requires the following IAM permission on the specified resource parent:

  • financialservices.v1instances.list

Query parameters

Parameters
pageSize

integer

The number of resources to be included in the response. The response contains a nextPageToken, which can be used to retrieve the next page of resources.
pageToken

string

In case of paginated results, this is the token that was returned in the previous ListInstancesResponse. It should be copied here to retrieve the next page of resources. This will be empty for the first instance of ListInstancesRequest.
filter

string

Specify a filter to narrow search results.
orderBy

string

Specify a field to use for ordering.

Request body

The request body must be empty.

Response body

Response for retrieving a list of Instances

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

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

object (Instance)

List of Instance resources
nextPageToken

string

This token should be passed to the next ListInstancesRequest to retrieve the next page of Instances.
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.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • financialservices.v1instances.list

For more information, see the IAM documentation.