一、功能描述
查询数据集和某个指定对象存储(COS)Bucket 的绑定关系。
二、授权说明
通过子账号使用时,需要在 授权策略 的 action 中添加 ci:DescribeDatasetBinding 权限。数据万象支持的所有操作接口请参见 CI action。
三、使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
四、请求示例
GET /datasetbinding?datasetname=test&uri=cos%3A%2F%2Fexample-1250000000 HTTP/1.1Host: <AppId>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: Auth StringAccept: application/json
注意:说明:
注意:Authorization:携带鉴权信息,用于验证请求的合法性的请求头,详情请参见 请求签名 文档。
五、请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
六、请求参数
| 参数名称 | 描述 | 类型 | 是否必选 |
| datasetname | 数据集名称,同一个账户下唯一。可通过 控制台 或 接口 查询。 | String | 是 |
| uri | 资源标识字段,表示需要查询与数据集绑定关系的资源,当前仅支持 COS 存储桶,字段规则:cos://<BucketName>,其中 BucketName 表示 COS 存储桶名称,例如(需要进行 URL Encode):cos%3A%2F%2Fexample-1250000000。 | String | 是 |
七、请求体
该请求的请求体为空。
八、响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
九、响应体
{ "Binding": { "CreateTime": "2023-12-26 17:28:33.617269703 +0800 CST", "DatasetName": "test", "State": "Running", "StockState": "Indexing", "URI": "cos://examplebucket2-1250000000", "UpdateTime": "2023-12-26 17:28:33.617269858 +0800 CST" }, "RequestId": "NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****"}
响应包体具体数据内容如下:
| 参数名称 | 类型 | 描述 |
| Binding | Container | 数据集和 COS Bucket 绑定关系信息。 |
| RequestId | String | 请求 ID。 |
Binding 节点内容:
| 参数名称 | 类型 | 描述 |
| CreateTime | String | 数据集和 COS Bucket 绑定关系创建时间的时间戳,格式为 RFC3339Nano。 |
| DatasetName | String | 数据集名称。 |
| State | String | 数据集和 COS Bucket 绑定关系的状态。取值范围如下:Running:绑定关系运行中。 |
| StockState | String | 当前绑定的存储桶对应的存量索引的状态:有效值如下:NoIndexing:未进行存量建立索引Indexing:存量索引建立中Success:存量索引已建立完成 |
| URI | String | 资源标识字段,表示需要查询与数据集绑定关系的资源,当前仅支持 COS 存储桶,字段规则:cos://<BucketName>,其中 BucketName 表示 COS 存储桶名称,例如:cos://examplebucket-1250000000。 |
| UpdateTime | String | 数据集和 COS Bucket 的绑定关系修改时间的时间戳,格式为 RFC3339Nano。创建绑定关系后,如果未暂停或者未重启过绑定关系,则绑定关系修改时间的时间戳和绑定关系创建时间的时间戳相同。 |