文档

CreateBinding - 创建绑定任务

更新时间:

创建数据集(Dataset)和对象存储(OSS)Bucket的绑定关系,自动同步全量和增量文件并为其索引。

接口说明

请确保在使用该接口前,已充分了解 IMM 产品的收费方式和价格

在创建绑定关系前,请确保已经创建对应的项目和数据集。

说明 数据绑定将使用创建项目或数据集时所指定的工作流模板对文件进行处理。

绑定关系创建后,智能媒体管理(IMM)会先对对象存储 (OSS) Bucket 中的已有数据进行全量扫描,并抽取文件元数据信息进行索引。完成后,继续对 OSS 中新增的文件进行准实时的增量追踪扫描、抽取以及索引。通过此方式为文件建立索引后,您可以使用文件查询 API(例如 SimpleQuery )对文件进行查询、管理和统计。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:CreateBindingcreate
  • Dataset
    acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称,获取方式请参见创建项目

test-project
DatasetNamestring

数据集名称,获取方式请参见创建数据集

test-dataset
URIstring

数据集绑定的对象存储(OSS) Bucket URI。

对象存储(OSS) Bucket URI 的格式为 oss://${Bucket},其中${Bucket}为和当前项目处于同一地域的 OSS Bucket 名称。

oss://test-bucket

返回参数

名称类型描述示例值
object

响应结构体。

RequestIdstring

请求 ID。

5F74C5C9-5AC0-49F9-914D-E01589D3****
BindingBinding

绑定信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "5F74C5C9-5AC0-49F9-914D-E01589D3****",
  "Binding": {
    "ProjectName": "immtest",
    "DatasetName": "dataset001",
    "URI": "oss://examplebucket",
    "State": "Running",
    "Phase": "FullScanning",
    "Detail": "已暂停。",
    "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
    "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
    "Reason": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-03OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情
2024-04-19OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更查看变更详情
2021-06-15新增 OpenAPI查看变更详情