Method: projects.locations.instances.list

Lists instances in a given project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project and location for which to retrieve a list of instances, in the format projects/{projectId}/locations/{location}.

To retrieve instance information for all locations, use "-" as the value of {location}.

Query parameters

Parameters
pageSize

integer

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

string

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

string

Optional. Filtering results.
orderBy

string

Optional. Desired order of results.

Request body

The request body must be empty.

Response body

Message for response to listing 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)

Response from instances.list.
nextPageToken

string

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

string

Unordered list. 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:

  • lustre.instances.list

For more information, see the IAM documentation.