get-vector-index

Updated at:

Use the get-vector-index command to retrieve the details of a vector index.

Permissions

By default, Alibaba Cloud accounts have all permissions. However, Resource Access Management (RAM) users and RAM roles have no permissions. An Alibaba Cloud account or an administrator must grant permissions for this operation using a RAM policy or a bucket policy.

API

Action

Description

GetVectorIndex

oss:GetVectorIndex

Gets information about a vector index.

Command format

ossutil vectors-api get-vector-index --bucket value --index-name value [flags]

Parameters

Parameter

Type

Description

--bucket

string

The name of the vector bucket.

--index-name

string

The name of the index.

Note

Examples

Retrieve the properties of the vector index named index in the vector bucket examplebucket.

ossutil vectors-api get-vector-index --bucket examplebucket --index-name index