すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeTasks

    ドキュメントセンター

    PolarDB:DescribeTasks

    最終更新日:Sep 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardbx:DescribeTasks

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス名。

    pxc-hzjasd****
    StartTime

    string

    必須

    タスクの開始時刻。

    2021-11-01
    EndTime

    string

    必須

    タスクの終了時刻。

    2021-11-04
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効な値: 5～1000。

    20
    PageNumber

    integer

    任意

    ページ番号。

    30
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    D6045D78-C119-5A17-9DEA-0F810394E008
    PageNumber

    integer

    ページ番号。

    1
    PageRecordCount

    integer

    1 ページあたりのエントリ数。

    30
    TotalRecordCount

    integer

    エントリの総数。

    2
    Items

    array<object>

    結果項目のリスト。

    object

    Status

    string

    タスクのステータス。有効な値:

    • RUNNING: タスクが実行中です。

    • FAILED: タスクが失敗したため、中断されました。

    RUNNING
    FinishTime

    string

    タスクの終了時刻。フォーマットは yyyy-MM-dd'T'HH:mm:ss'Z' です。

    2021-10-20T20:00:00Z
    Progress

    string

    タスクの進捗状況（%）。

    80
    BeginTime

    string

    タスクの開始時刻。フォーマットは yyyy-MM-dd'T'HH:mm:ss'Z' です。

    2021-10-20T19:40:00Z
    TaskErrorCode

    string

    失敗したタスクのエラーコード。

    TaskErrorCode
    DBName

    string

    タスクに関連付けられたデータベース名。通常、このパラメーターは空です。

    DBName
    ProgressInfo

    string

    タスクの詳細な進捗情報。通常、このパラメーターは空です。

    ProgressInfo
    ScaleOutToken

    string

    タスクがスケールアウトタスクである場合のスケールアウト ID。バックエンドにおける一意キーです。

    FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    TaskId

    string

    タスク ID。

    20089398
    TaskErrorMessage

    string

    失敗したタスクのエラーメッセージ。

    TaskErrorMessage
    TaskAction

    string

    タスクの操作。バックエンドのタスクタイプに対する一意キーです。

    multi_scale_out

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D6045D78-C119-5A17-9DEA-0F810394E008",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "RUNNING",
      "FinishTime": "2021-10-20T20:00:00Z",
      "Progress": "80",
      "BeginTime": "2021-10-20T19:40:00Z",
      "TaskErrorCode": "TaskErrorCode",
      "DBName": "DBName",
      "ProgressInfo": "ProgressInfo",
      "ScaleOutToken": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
      "TaskId": "20089398",
      "TaskErrorMessage": "TaskErrorMessage",
      "TaskAction": "multi_scale_out"
    }
  ]
}

    エラーコード

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

    変更履歴

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