查询批处理任务列表，支持排序，支持按照任务标签，任务状态等条件查询。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:ListBatches | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称，获取方式请参见创建项目。 | test-project |
| State | string | 否 | 批处理任务状态：
| Succeed |
| Sort | string | 否 | 排序字段，取值范围如下：
| 2020-11-11T06:51:17.5Z |
| Order | string | 否 | 排序方式。取值范围如下：
| ASC |
| TagSelector | string | 否 | 自定义任务标签。在创建任务时如果指定了“Tags”参数，可以通过此参数进行搜索。 | test=val1 |
| NextToken | string | 否 | 翻页标记。 当文件总数大于设置的 MaxResults 时，用于翻页的 Token。从 NextToken 开始按字典序返回文件信息列表。 第一次调用此接口时，设置为空。 | MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw== |
| MaxResults | integer | 否 | 返回文件的最大个数，取值范围为 0~100。 不设置此参数或者设置为 0 时，则默认值为 100。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"Batches": [
{
"Id": "trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****",
"Input": {
"OSS": {
"Bucket": "test-bucket",
"Prefix": "test-object",
"MatchExpressions": [
"key prefix (abc)"
]
}
},
"Actions": [
{
"Name": "doc/convert",
"Parameters": [
"pages=3"
],
"FastFailPolicy": {
"Action": "abort"
}
}
],
"Notification": {
"Endpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
"Topic": "topic1",
"MNS": {
"TopicName": "topic1",
"Endpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com"
},
"RocketMQ": {
"Endpoint": "http://11111111111.mqrest.cn-hangzhou.aliyuncs.com",
"TopicName": "topic1",
"InstanceId": "MQ_INST_11111111111_BYcNy2Nc"
}
},
"Statistic": {
"SubmitSuccess": 10,
"SubmitFailure": 1,
"SkipFiles": 0
},
"State": "Succeeded",
"Marker": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****",
"CreateTime": "2020-11-10T03:50:28Z",
"UpdateTime": "2021-12-18T07:40:29Z",
"Tags": {
"test": "test",
"test2": 1
},
"Error": "api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound",
"Phase": "IncrementalScanning",
"ServiceRole": "AliyunIMMBatchTriggerRole"
}
],
"NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****",
"RequestId": "FEDC9B1F-30F2-4C1F-8ED2-B7860187****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史