调用GetBatch获取批处理任务信息_智能媒体管理(IMM)-阿里云帮助中心

获取批处理任务信息。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
imm:GetBatch	get	Batch acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*	无	无

请求参数

名称	类型	必填	描述	示例值
ProjectName	string	是	项目名称，获取方式请参见创建项目。	test-project
Id	string	是	批处理任务 ID，获取方式请参见创建批处理。	batch-4eb9223f-3e88-42d3-a578-3f2852******

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Batch	DataIngestion	批处理任务信息。
RequestId	string	请求 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****"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史