绑定存储桶与数据集

最近更新时间:2025-06-17 20:13:52

我的收藏

简介

本文档提供关于绑定存储桶与数据集的相关 API 概览以及 SDK 示例代码。
API
操作描述
绑定存储桶与数据集

功能说明

将一个对象存储(COS)存储桶绑定到数据集(Dataset)上。绑定后,将对存储桶中新增的文件进行准实时的增量追踪扫描,依据数据集的检索模板对文件进行处理,抽取文件的元数据进行索引。通过此方式为文件建立元数据索引后,您可以使用智能检索的查询接口进行数据的查询统计。

示例代码

from qcloud_cos import CosConfig
from qcloud_cos import MetaInsightClient
import os
import sys

# 替换为用户的 SecretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
secret_id = os.environ["SECRETID"]
# 替换为用户的 SecretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
secret_key = os.environ["SECRETKEY"]
# 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
region = ('ap-beijing')
# COS 支持的所有 region 列表参见 https://www.qcloud.com/document/product/436/6224
token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
# 用户 appid 请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
appid = '1250000000'

config = CosConfig(Appid=appid, Region=region, SecretId=secret_id,
SecretKey=secret_key,
Token=token) # 获取配置对象
client = MetaInsightClient(config)

def ci_create_dataset_binding():
# 绑定存储桶与数据集
body = {
# 数据集名称,同一个账户下唯一。
# 是否必传:是
'DatasetName': "test",
# 资源标识字段,表示需要与数据集绑定的资源,当前仅支持 COS 存储桶,字段规则:cos://<BucketName>,其中 BucketName 表示 COS 存储桶名称,例如:cos://examplebucket-1250000000
# 是否必传:是
'URI': "cos://examplebucket-1250000000",
}
response, data = client.ci_create_dataset_binding(
Body=body,
ContentType="application/json"
)
print(response)
print(data)
return response, data

参数说明

调用 ci_create_dataset_binding 函数,具体请求参数如下:
参数名称
参数描述
类型
是否必填
Body
绑定存储桶与数据集请求参数。
Container
Body 节点内容:
参数名称
参数描述
类型
是否必填
DatasetName
数据集名称,同一个账户下唯一。
String
URI
资源标识字段,表示需要与数据集绑定的资源,当前仅支持 COS 存储桶,字段规则:cos://<BucketName>,其中 BucketName 表示 COS 存储桶名称,例如:cos://examplebucket-1250000000
String

返回结果说明

response 为响应头,data 为响应结果,数据类型都为 dict。

response 内容

返回公共响应头部,详情请参见 公共响应头部 文档。

响应体 data

响应体具体数据内容如下:
参数名称
参数描述
类型
RequestId
请求 ID。
String
Binding
绑定信息。
Container
Binding 节点内容:
参数名称
参数描述
类型
URI
资源标识字段,表示需要与数据集绑定的资源,当前仅支持 COS 存储桶,字段规则:cos://<BucketName>,其中 BucketName 表示 COS 存储桶名称,例如:cos://examplebucket-1250000000
String
State
数据集和 COS Bucket 绑定关系的状态。取值范围如下:
Running:绑定关系运行中。
String
CreateTime
数据集和 COS Bucket 绑定关系创建时间的时间戳,格式为 RFC3339Nano。
String
UpdateTime
数据集和 COS Bucket 的绑定关系修改时间的时间戳,格式为 RFC3339Nano。
创建绑定关系后,如果未暂停或者未重启过绑定关系,则绑定关系修改时间的时间戳和绑定关系创建时间的时间戳相同。
String
DatasetName
数据集名称。
String