Method: projects.locations.corpora.indexes.get

Gets the details of a single Index under a Corpus.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the Index resource. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Index.

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 name resource:

  • visionai.indexes.get

For more information, see the IAM documentation.