文档

CreateBatch - 创建批处理任务

更新时间:

创建一个批处理任务,指定存储内已存在的若干文件,对其批量执行指定操作,如转码、格式转换等。

接口说明

创建批处理任务,如果需要通过对象存储数据处理方式进行数据处理,请确保已经完成了绑定对象存储桶的操作。

调试

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

授权信息

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

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

请求参数

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

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

test-project
InputInput

输入的数据源配置。

Actionsarray<object>

处理模板列表。

object

处理模板。

Namestring

模板名字。

doc/convert
Parametersarray

模板参数列表。

string

模板参数。

pages=3
FastFailPolicyFastFailPolicy

快速失败执行策略配置。

Notificationobject

消息通知对象,支持多种消息中间件,消息格式详情请见异步通知消息格式,请选择其中一种方式接收消息,使用方式如下所示:

在与智能媒体管理相同的地域下开通并接入事件总线 EventBridge 服务,及时获取任务信息通知。更多信息,请参见智能媒体管理 IMM 事件。 在与智能媒体管理相同的地域下开通 MNS 服务,并配置订阅关系。

MNSMNS

MNS 通知参数对象。

Tagsobject

自定义标签,用于对异步任务进行搜索、过滤。

{"key": "val"}
ServiceRolestring

服务角色,授权给 IMM 服务以访问其他云资源(例如 OSS)的权限,默认值为 AliyunIMMBatchTriggerRole。

如果要自定义服务角色,您可以通过 RAM 控制台创建普通服务角色并为角色授权。具体操作,请分别参见创建普通服务角色为角色授权

AliyunIMMBatchTriggerRole

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

EC564A9A-BA5C-4499-A087-D9B9E76E*****
Idstring

批处理任务 ID。

batch-4eb9223f-3e88-42d3-a578-3f2852******

示例

正常返回示例

JSON格式

{
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "Id": "batch-4eb9223f-3e88-42d3-a578-3f2852******"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-05API 内部配置变更,不影响调用查看变更详情