文档

GetBatch - 获取批处理任务信息

更新时间:

获取批处理任务信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

test-project
Idstring

批处理任务 ID,获取方式请参见创建批处理

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

返回参数

名称类型描述示例值
object

Schema of Response

BatchDataIngestion

批处理任务信息。

RequestIdstring

请求 ID。

6E93D6C9-5AC0-49F9-914D-E02678D3****

示例

正常返回示例

JSON格式

{
  "Batch": {
    "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"
  },
  "RequestId": "6E93D6C9-5AC0-49F9-914D-E02678D3****"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史