列举向量桶

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

我的收藏

简介

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

功能说明

列出账户下的所有向量桶。

方法原型

list_vector_buckets(self, 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_vector_buckets()
print('向量桶列表获取成功')
print('响应头:', resp)
print('桶列表:', data)
# 遍历桶列表
if 'buckets' in data:
for bucket in data['buckets']:
print(f"- {bucket['bucketName']}")
except CosServiceError as e:
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_vector_buckets(
MaxResults=10, # 每页返回10个结果
NextToken=None # 用于获取下一页,首次为 None
)
print('首页数据:', data)
# 如果有更多数据,继续获取下一页
if 'nextToken' in data and data['nextToken']:
next_resp, next_data = client.list_vector_buckets(
MaxResults=10,
NextToken=data['nextToken']
)
print('下一页数据:', next_data)
except CosServiceError as e:
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_vector_buckets(
Prefix='my-', # 只返回以 'my-' 开头的桶
MaxResults=20
)
print('过滤后的桶列表:', data)
except CosServiceError as e:
print(f'列举失败: {e}')

参数说明

参数
描述
类型
是否必选
MaxResults
单次返回的最大结果数,默认为 100
int
NextToken
分页令牌,用于获取下一页
string
Prefix
桶名称前缀过滤,将响应限制为以指定向量桶名称前缀开头的向量桶。
string

返回结果说明

返回值

resp (dict): 响应头信息。
data (dict): 响应数据,包含向量桶列表,每一项包含桶的元数据信息,详细结构可参考 ListVectorBuckets

错误处理

如果请求失败,将会抛出 CosServiceError 或者 CosClientError 异常,详细介绍请参见 异常处理