Method: indexes.get

Full name: projects.locations.indexes.get

Gets an Index.

Endpoint

get https://{service-endpoint}/v1beta1/{name}

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

Path parameters

name string

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}

Request body

The request body must be empty.

Response body

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

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.indexes.get

For more information, see the IAM documentation.