All Products
Search

This Product

    Object Storage Service:list-vector-indexes

    Document Center

    Object Storage Service:list-vector-indexes

    Last Updated:Mar 20, 2026

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

    Syntax

    ossutil vectors-api list-vector-indexes --bucket <bucket-name> [flags]

    Parameters

    ParameterTypeDescription
    --bucketstringThe name of the vector bucket. Required.
    --max-resultsintThe maximum number of indexes to return. Valid values: 0–500. Defaults to 100 if not set or set to 0.
    --next-tokenstringThe pagination token. Set this to the nextToken value from the previous response to retrieve the next page. Indexes are returned in lexicographic order starting from the specified token. Leave blank for the first call. The token can be 1–512 bytes in length.
    --prefixstringReturns only indexes whose names start with the specified prefix.
    Each ListVectorIndexes call returns at most 500 indexes. Use --next-token to paginate through additional results. The operation supports a maximum of 16 concurrent calls.
    The list-vector-indexes command maps to the ListVectorIndexes API operation. For supported global command-line options, see Supported global command-line options.

    Permissions

    By default, Alibaba Cloud accounts have full permissions. Resource Access Management (RAM) users and RAM roles have no permissions by default. An Alibaba Cloud account or an administrator must grant access via a RAM policy or a bucket policy.

    APIActionDescription
    ListVectorIndexesoss:ListVectorIndexesLists vector indexes.

    Examples

    List all vector indexes in a bucket

    ossutil vectors-api list-vector-indexes --bucket examplebucket

    List indexes by prefix

    Return only indexes whose names start with example:

    ossutil vectors-api list-vector-indexes --bucket examplebucket --prefix example

    Limit the number of results

    Return the first 20 indexes:

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

    Paginate through results

    Use --next-token with the token from the previous response to retrieve the next page:

    ossutil vectors-api list-vector-indexes --bucket examplebucket --next-token CAESCG15aC1xxxxx