Method: projects.locations.instances.list

Lists Instances in a given project and location.

HTTP request

GET https://memorystore.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent to list instances from. Format: projects/{project}/locations/{location}

Query parameters

Parameters
pageSize

integer

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

string

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

string

Optional. Expression for filtering results.
orderBy

string

Optional. Sort results by a defined order. Supported values: "name", "createTime".

Request body

The request body must be empty.

Response body

Response message for [instances.list][]. The list of instances in the specified location.

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

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

object (Instance)

If the {location} requested was "-" the response contains a list of instances from all locations. Instances in unreachable locations will be omitted.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

IAM Permissions

Requires the following IAM permission on the parent resource:

  • memorystore.instances.list

For more information, see the IAM documentation.