文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>对象存储>向量存储与检索>向量存储桶>Python SDK>向量索引操作>列举索引

列举索引

最近更新时间：2026-01-22 17:15:02

我的收藏

本页目录：

简介

本文介绍向量桶通过 Python SDK 实现列举索引功能的示例代码和描述。

功能说明

列出向量桶中的所有索引。

方法原型

list_indexes(self, Bucket, MaxResults=None, NextToken=None, Prefix=None, **kwargs)

使用案例

获取所有索引

# -*- coding=utf-8
import sys
import os
from pprint import pprint
from qcloud_cos import CosServiceError
from qcloud_cos import CosConfig
from qcloud_cos import CosVectorsClient
import logging

# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.getenv("COS_VECTORS_SECRET_ID")     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
secret_key = os.getenv("COS_VECTORS_SECRET_KEY")   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-guangzhou'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'http'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填

config = CosConfig(
    Region=region, 
    SecretId=secret_id, 
    SecretKey=secret_key,
    Scheme=scheme,
    Domain="vectors.ap-guangzhou.coslake.com",
    Token=token,
)
client = CosVectorsClient(config)


try:
    resp, data = client.list_indexes(
        Bucket='examplebucket-1250000000'
    )
    print('索引列表获取成功')
    print('响应头:', resp)
    print('索引列表:', data)
    
    # 遍历索引列表
    if 'indexes' in data:
        for idx in data['indexes']:
            print(f"- {idx['indexName']}")
except CosServiceError as e:
    if e.get_error_code() == "NotFoundException":
        print("资源不存在")
    print(f'列举失败: {e}')

获取带分页的索引

# -*- coding=utf-8
import sys
import os
from pprint import pprint
from qcloud_cos import CosServiceError
from qcloud_cos import CosConfig
from qcloud_cos import CosVectorsClient
import logging

# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.getenv("COS_VECTORS_SECRET_ID")     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
secret_key = os.getenv("COS_VECTORS_SECRET_KEY")   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-guangzhou'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'http'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填

config = CosConfig(
    Region=region, 
    SecretId=secret_id, 
    SecretKey=secret_key,
    Scheme=scheme,
    Domain="vectors.ap-guangzhou.coslake.com",
    Token=token,
)
client = CosVectorsClient(config)

try:
    resp, data = client.list_indexes(
        Bucket='examplebucket-1250000000',
        MaxResults=10,
        NextToken=None
    )
    print('首页索引列表:', data)
    
    # 获取下一页
    if 'nextToken' in data and data['nextToken']:
        next_resp, next_data = client.list_indexes(
            Bucket='examplebucket-1250000000',
            MaxResults=10,
            NextToken=data['nextToken']
        )
        print('下一页索引列表:', next_data)
except CosServiceError as e:
    if e.get_error_code() == "NotFoundException":
        print("资源不存在")
    print(f'列举失败: {e}')

获取带前缀过滤的索引

# -*- coding=utf-8
import sys
import os
from pprint import pprint
from qcloud_cos import CosServiceError
from qcloud_cos import CosConfig
from qcloud_cos import CosVectorsClient
import logging

# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)

# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.getenv("COS_VECTORS_SECRET_ID")     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
secret_key = os.getenv("COS_VECTORS_SECRET_KEY")   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-guangzhou'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'http'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填

config = CosConfig(
    Region=region, 
    SecretId=secret_id, 
    SecretKey=secret_key,
    Scheme=scheme,
    Domain="vectors.ap-guangzhou.coslake.com",
    Token=token,
)
client = CosVectorsClient(config)

try:
    resp, data = client.list_indexes(
        Bucket='examplebucket-1250000000',
        Prefix='test-',     # 只返回以 'test-' 开头的索引
        MaxResults=20
    )
    print('过滤后的索引列表:', data)
except CosServiceError as e:
    if e.get_error_code() == "NotFoundException":
        print("资源不存在")
    print(f'列举失败: {e}')

参数说明

参数
描述
类型
是否必选
Bucket
向量桶名称，<BucketName-APPID>格式，例如 examplebucket-1250000000，支持小写字母、数字和 - ，长度限制3-63字符
string
是
MaxResults
响应中要返回的向量桶索引的最大数量
int
否
NextToken
上一个分页标记。最小长度为1，最大长度为512。默认不填则从头开始遍历
string
否
Prefix
将响应限制为以指定索引名称前缀开头的向量桶索引
string
否

返回结果说明

返回值

resp (dict): 响应头信息
data (dict): 响应数据，包含索引列表，每一项包含索引的元数据信息，详细结构可参考 ListIndexes。

错误处理

如果请求失败，将会抛出 CosServiceError 或者 CosClientError 异常，详细介绍请参见 异常处理。
中国站
目录