GetBatch によるバッチ処理タスクのクエリ - Intelligent Media Management (IMM)

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

imm:GetBatch

get

*Batch

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectName	string	必須	プロジェクトの名前です。詳細については、「CreateProject」をご参照ください。	test-project
Id	string	必須	バッチ処理タスクの ID です。ID の取得方法の詳細については、「CreateBatch」をご参照ください。	batch-4eb9223f-3e88-42d3-a578-3f2852******

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ
Batch	DataIngestion	バッチ処理タスクに関する情報です。
RequestId	string	リクエスト ID です。	6E93D6C9-5AC0-49F9-914D-E02678D3****

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。