Method: projects.locations.indexes.get

Gets an Index.

HTTP request

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

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

Path parameters

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.

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:

  • aiplatform.indexes.get

For more information, see the IAM documentation.