创建数据集(Dataset)和对象存储(OSS)Bucket的绑定关系,自动同步全量和增量文件并为其索引。
接口说明
请确保在使用该接口前,已充分了解 IMM 产品的收费方式和价格。
注意 异步任务不保证时效。
说明
数据绑定将使用创建项目或数据集时所指定的工作流模板对文件进行处理。
绑定关系创建后,智能媒体管理(IMM)会先对对象存储 (OSS) Bucket 中的已有数据进行全量扫描,并抽取文件元数据信息进行索引。完成后,继续对 OSS 中新增的文件进行准实时的增量追踪扫描、抽取以及索引。通过此方式为文件建立索引后,您可以使用文件查询 API(例如 SimpleQuery )对文件进行查询、管理和统计。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称,获取方式请参见创建项目。 | test-project |
| DatasetName | string | 是 | 数据集名称,获取方式请参见创建数据集。 | test-dataset |
| URI | string | 是 | 数据集绑定的对象存储(OSS) Bucket URI。 对象存储(OSS) Bucket URI 的格式为 oss://${Bucket},其中 | oss://test-bucket |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "5F74C5C9-5AC0-49F9-914D-E01589D3****",
"Binding": {
"ProjectName": "immtest",
"DatasetName": "dataset001",
"URI": "oss://examplebucket",
"State": "Running",
"Phase": "FullScanning",
"Detail": "start oss tunnel failed",
"CreateTime": "2021-06-29T14:50:13.011643661+08:00",
"UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
"Reason": "暂停使用",
"Filters": [
[
"Size > 1024,FileModifiedTime > 2025-06-03T09:20:47.999Z",
"Filename prefix (YWEvYmIv)"
]
],
"ServiceRole": "AliyunIMMDefaultRole",
"Notification": {
"MNS": {
"TopicName": "topic1"
},
"WithFields": [
"Filename"
]
},
"WorkflowParameters": [
{
"Value": "",
"Name": ""
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-03 | OpenAPI 描述信息更新、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-04-19 | OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2021-06-15 | 新增 OpenAPI | 查看变更详情 |
