Method: projects.locations.indexes.list

Lists Indexes in a Location.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/indexes

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

Path parameters

Parameters
parent

string

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

The standard list filter.
pageSize

integer

The standard list page size.
pageToken

string

The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.
readMask

string (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

Response message for IndexService.ListIndexes.

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

JSON representation 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "nextPageToken": string
}
Fields
indexes[]

object (Index)

List of indexes in the requested page.
nextPageToken

string

A token to retrieve next page of results. Pass to ListIndexesRequest.page_token to obtain that page.

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:

  • aiplatform.indexes.list

For more information, see the IAM documentation.