Use the get-vector-index command to retrieve the details of a vector index.
Permissions
By default, Alibaba Cloud accounts have all permissions. Resource Access Management (RAM) users and RAM roles have no permissions by default. An Alibaba Cloud account or an administrator must grant permissions using a RAM policy or a bucket policy.
| API | Action | Description |
|---|---|---|
| GetVectorIndex | oss:GetVectorIndex | Gets information about a vector index |
Syntax
ossutil vectors-api get-vector-index --bucket <value> --index-name <value> [flags]Both --bucket and --index-name are required to identify the vector index.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
--bucket | string | Yes | The name of the vector bucket |
--index-name | string | Yes | The name of the index |
This command corresponds to the GetVectorIndex API operation. For supported global flags, see Supported global command line options.
Examples
Retrieve the details of the vector index named index in the vector bucket examplebucket:
ossutil vectors-api get-vector-index --bucket examplebucket --index-name index