すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeBatchTasks

    ドキュメントセンター

    PolarDB:DescribeBatchTasks

    最終更新日:Sep 24, 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:DescribeBatchTasks

    none

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TaskType

    string

    任意

    バッチタスクタイプ。

    polarclaw_install_skills
    Status

    array

    任意

    タスクステータスのリスト。

    説明

    このパラメーターが空の場合、デフォルトですべてのステータスのスケジュール済みタスクが照会されます。

    string

    任意

    タスクステータス。

    列挙値:

    • COMPLETED :

      完了。

    • DISPATCHING :

      ディスパッチ中。

    • FAILED :

      失敗。

    • RUNNING :

      実行中。

    RUNNING
    StartTime

    string

    任意

    作成時間の有効範囲の開始時刻。

    時間は、協定世界時 (UTC) の ISO 8601 フォーマット (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2026-04-06T20:51:40Z
    EndTime

    string

    任意

    作成時間の有効範囲の終了時刻。

    時間は、協定世界時 (UTC) の ISO 8601 フォーマット (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2026-04-06T20:52:40Z
    PageSize

    integer

    任意

    1 ページあたりのレコード数。

    30
    PageNumber

    integer

    任意

    ページ番号。値は、Integer データの型の最大値を超えない正の整数である必要があります。デフォルト値: 1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    RequestId

    string

    リクエストの ID。

    925B84D9-CA72-432C-95CF-738C22******
    TaskList

    array<object>

    タスク情報。

    object

    サブタスクのリスト。

    BatchId

    string

    バッチタスクの ID。

    pcb-xxx
    TaskName

    string

    モデルサービスの説明。

    バッチ_タスク_テスト
    TaskType

    string

    タスクタイプ。

    polarclaw_install_skills
    Status

    string

    タスクステータス。

    RUNNING
    TotalCount

    integer

    ページネーションに関係なく、フィルター条件を満たすタスクの総数。

    8
    SuccessCount

    integer

    成功したバッチタスクの数。

    4
    TaskBegin

    string

    タスクの開始時間。

    2026-04-06 20:51:44
    TaskEnd

    string

    タスクの終了時間。

    2026-04-06 22:43:26
    TotalCount

    integer

    ページネーションに関係なく、フィルター条件を満たすタスクの総数。

    6
    PageSize

    integer

    1 ページあたりのレコード数。

    30
    PageNumber

    integer

    ページ番号。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******",
  "TaskList": [
    {
      "BatchId": "pcb-xxx",
      "TaskName": "batch_task_test",
      "TaskType": "polarclaw_install_skills",
      "Status": "RUNNING",
      "TotalCount": 8,
      "SuccessCount": 4,
      "TaskBegin": "2026-04-06 20:51:44",
      "TaskEnd": "2026-04-06 22:43:26"
    }
  ],
  "TotalCount": 6,
  "PageSize": 30,
  "PageNumber": 1
}

    エラーコード

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

    変更履歴

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