調用ListBatches擷取批處理工作清單-Intelligent Media Management-阿里雲

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:ListBatches

list

*Batch

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectName	string	是	專案名稱，擷取方式請參見建立專案。	test-project
State	string	否	批處理任務狀態： Ready：任務就緒，剛建立的任務處於 Ready 狀態。 Running：正在執行，正常執行的任務狀態。 Failed：任務失敗，任務執行出錯，且無法自動回復。 Suspended：任務暫停。 Succeeded：任務執行完成。	Succeed
Sort	string	否	排序欄位，取值範圍如下： CreateTime：按任務建立時間排序。 UpdateTime：按任務更新時間排序。	2020-11-11T06:51:17.5Z
Order	string	否	排序方式。取值範圍如下： ASC（預設）：升序 DES：降序	ASC
TagSelector	string	否	自訂任務標籤。在建立任務時如果指定了“Tags”參數，可以通過此參數進行搜尋。	test=val1
NextToken	string	否	翻頁標記。當檔案總數大於設定的 MaxResults 時，用於翻頁的 Token。從 NextToken 開始按字典序返迴文件資訊列表。第一次調用此介面時，設定為空白。	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResults	integer	否	返迴文件的最大個數，取值範圍為 0~100。不設定此參數或者設定為 0 時，則預設值為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Batches	array	批處理工作清單。
	DataIngestion	批處理任務資訊。
NextToken	string	翻頁標記。當檔案總數大於設定的 MaxResults 時，用於翻頁的 Token。從 NextToken 開始按字典序返迴文件資訊列表。第一次調用此介面時，設定為空白。	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****
RequestId	string	請求 ID。	FEDC9B1F-30F2-4C1F-8ED2-B7860187****

樣本

正常返回樣本

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****"
}

錯誤碼

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

變更歷史

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