如何調用GetBatch API擷取批處理任務資訊-Intelligent Media Management-阿里雲

調試

您可以在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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。