Method: projects.locations.corpora.indexes.list

List all Indexes in a given Corpus.

HTTP request

GET https://visionai.googleapis.com/v1/{parent=projects/*/locations/*/corpora/*}/indexes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent corpus that owns this collection of indexes. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

Query parameters

Parameters
pageSize

integer

The maximum number of indexes to return. The service may return fewer than this value. If unspecified, at most 50 indexes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous indexes.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to indexes.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for indexes.list.

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

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

object (Index)

The indexes under the specified corpus.
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.

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:

  • visionai.indexes.list

For more information, see the IAM documentation.