すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeBatchTask

最終更新日:Jun 10, 2026

バッチタスクのステータスを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeBatchTask

none

*All Resource

*

なし なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

BatchId

string

任意

バッチタスクの ID。

pcb-xxx

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスボディ。

RequestId

string

リクエスト ID。

25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB

BatchId

string

バッチタスクの ID。

pcb-xxx

TaskName

string

タスク名。

batch_task_test

TaskType

string

タスクのタイプ。

polarclaw_install_skills

Status

string

タスクのステータス。

列挙値:

  • COMPLETED :

    完了

  • DISPATCHING :

    ディスパッチ中

  • FAILED :

    失敗

  • RUNNING :

    実行中

RUNNING

TotalCount

integer

サブタスクの合計数。

10

SuccessCount

integer

成功したサブタスクの数。

8

TaskBegin

string

タスクが開始された時刻。

2026/05/28T16:38:20Z

TaskEnd

string

タスクが終了した時刻。

2026/05/28T15:23:47Z

SubTasks

array<object>

サブタスクのリスト。

object

サブタスク。

TaskId

string

サブタスクの ID。

629271331

InstanceId

string

インスタンス ID。

pc-pz5f6mvi1p84t35d7

Status

string

サブタスクのステータス。

列挙値:

  • COMPLETED :

    完了

  • FAILED :

    失敗

  • PAUSE :

    一時停止

  • RUNNING :

    実行中

  • TEMP_TERMINATED :

    一時的に終了

  • WAITING :

    待機中

  • HUMAN_PROCESSING :

    手動処理中

  • BLOCKING :

    ブロック中

COMPLETED

TaskBegin

string

サブタスクが開始された時刻。

2026/05/28T17:38:20Z

TaskEnd

string

サブタスクが終了した時刻。

2026/05/28T20:38:20Z

ErrorMsg

string

エラーメッセージ。

aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole

ApplicationType

string

例

成功レスポンス

JSONJSON

{
  "RequestId": "25C70FF3-D49B-594D-BECE-0DE2BA1D8BBB",
  "BatchId": "pcb-xxx",
  "TaskName": "batch_task_test",
  "TaskType": "polarclaw_install_skills",
  "Status": "RUNNING ",
  "TotalCount": 10,
  "SuccessCount": 8,
  "TaskBegin": "2026/05/28T16:38:20Z",
  "TaskEnd": "2026/05/28T15:23:47Z",
  "SubTasks": [
    {
      "TaskId": "629271331",
      "InstanceId": "pc-pz5f6mvi1p84t35d7",
      "Status": "COMPLETED",
      "TaskBegin": "2026/05/28T17:38:20Z",
      "TaskEnd": "2026/05/28T20:38:20Z",
      "ErrorMsg": "aliuid:1422133474238823 assumeOssRole not exist,serviceName:aliyunesarealtimelogpushossrole"
    }
  ],
  "ApplicationType": ""
}

エラーコード

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

変更履歴

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