list-vector-indexes - Object Storage Service - Alibaba Cloud Documentation Center

Use the list-vector-indexes command to list all vector indexes in a vector bucket.

Important

The ListVectorIndexes operation returns a maximum of 500 indexes per call. Use paging to retrieve the next batch of indexes.
The ListVectorIndexes operation supports a maximum of 16 concurrent calls.

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
ListVectorIndexes	`oss:ListVectorIndexes`	Lists vector indexes.

Command format

ossutil vectors-api list-vector-indexes --bucket value [flags]

Parameters

Parameter	Type	Description
--bucket	string	The name of the vector bucket.
--max-results	int	The maximum number of indexes to return. Valid values: 0 to 500. If you do not set this parameter or set it to 0, the default value is 100.
--next-token	string	The pagination token. Set this parameter to the nextToken value from the previous API call to retrieve the next page of results. Indexes are returned in lexicographic order, starting from the specified token. For the first call, leave this parameter empty. The token can be 1 to 512 bytes in length.
--prefix	string	Prefix matching for vector indexes.

Note

The list-vector-indexes command corresponds to the ListVectorIndexes API operation.
For more information about supported global command-line options, see Supported global command-line options.

Examples

List all vector indexes in the vector bucket named examplebucket.
```
ossutil vectors-api list-vector-indexes --bucket examplebucket
```
List the vector indexes that have the prefix example in the vector bucket named examplebucket.
```
ossutil vectors-api list-vector-indexes --bucket examplebucket --prefix example
```

List the first 20 vector indexes in the vector bucket named examplebucket.

ossutil vectors-api list-vector-indexes --bucket examplebucket --max-results 20

List the vector indexes in the vector bucket named examplebucket, starting from CAESCG15aC1xxxxx.
```
ossutil vectors-api list-vector-indexes --bucket examplebucket --next-token CAESCG15aC1xxxxx
```