すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeHistoryTasks

    ドキュメントセンター

    PolarDB:DescribeHistoryTasks

    最終更新日:Dec 11, 2025

    PolarDB for MySQL インスタンスのパラメーター変更やインスタンスの再起動など、履歴管理タスクのリストを取得します。

    今すぐお試しください

    この 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:DescribeHistoryTasks

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    説明

    詳細については、「DescribeRegions」をご参照ください。

    cn-beijing
    PageSize

    integer

    任意

    1 ページあたりのレコード数。有効値：10～100。デフォルト値：10。

    10
    PageNumber

    integer

    任意

    ページ番号。有効値：正の整数。デフォルト値：1。

    1
    InstanceType

    string

    任意

    現在、Instance のみがサポートされています。

    Instance
    Status

    string

    任意

    タスクのステータス。有効な値は次のとおりです。

    • Scheduled：実行待機中

    • Running：実行中

    • Succeed：実行成功

    • Cancelling：停止中

    • Canceled：停止済み

    • Waiting：プリセット時間待機中

    コンマ区切りのリストで指定できます。デフォルト値は空で、すべてのステータスを示します。

    Running
    InstanceId

    string

    任意

    フィルター対象のリソース ID。最大 30 個の ID をコンマ区切りで指定できます。デフォルト値は空で、制限がないことを示します。

    説明

    現在、PolarDB クラスター ID のみがサポートされています。

    pc-2zed3m89cw***
    TaskId

    string

    任意

    タスク ID。最大 30 個の ID をコンマ区切りで指定できます。デフォルト値は空で、制限がないことを示します。

    t-0mqi38ho0cgjv***
    TaskType

    string

    任意

    タスクタイプ。最大 30 個のタスクタイプをコンマ区切りで指定できます。デフォルト値は空で、制限がないことを示します。

    ChangeVariable
    FromStartTime

    string

    必須

    タスクの開始時刻に基づいてクエリする時間範囲の開始時刻。時刻は ISO 8601 標準に準拠し、UTC+0 タイムである必要があります。フォーマット：yyyy-MM-ddTHH:mm:ssZ。

    サポートされる最も古い時刻は 30 日前です。指定された時刻が 30 日以上前の場合、自動的に 30 日前に変換されます。

    2025-01-02T11:31:03Z
    ToStartTime

    string

    必須

    タスクの開始時刻に基づいてクエリする時間範囲の終了時刻。時刻は ISO 8601 標準に準拠し、UTC+0 タイムである必要があります。フォーマット：yyyy-MM-ddTHH:mm:ssZ。

    2025-01-03T11:31:03Z
    FromExecTime

    integer

    任意

    タスクの最小実行時間 (秒)。この値より実行時間が長いタスクがフィルターされます。デフォルト値：0。

    0
    ToExecTime

    integer

    任意

    タスクの最大実行時間 (秒)。この値より実行時間が短いタスクがフィルターされます。デフォルト値：0。

    0
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたパラメーターの詳細。

    PageNumber

    integer

    クエリ結果のページ番号。

    1
    RequestId

    string

    リクエストの一意の ID。

    F90D7C14-2D1C-5B88-9CD1-23AB2CF89***
    PageSize

    integer

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

    10
    TotalCount

    string

    フィルター条件に一致するタスクの総数。ページング要因は考慮されません。

    2
    Items

    array<object>

    タスクのリスト。

    object

    タスクオブジェクト。

    Status

    string

    タスクの最終ステータス。

    • Scheduled：実行待機中

    • Running：実行中

    • Succeed：実行成功

    • Failed：実行失敗

    • Cancelling：停止中

    • Canceled：停止済み

    • Waiting：プリセット時間待機中

    Succeed
    TaskId

    string

    タスク ID。

    t-0mqt8qhnw04ipz0***
    CurrentStepName

    string

    現在実行中のステップ名。このパラメーターが空の場合、タスクは開始されていません。

    finish_task
    StartTime

    string

    タスクの開始時刻。

    2025-03-03T07:25:16Z
    EndTime

    string

    タスクの終了時刻。

    2025-03-03T07:30:57Z
    TaskType

    string

    タスクタイプ。

    ChangeVariable
    RemainTime

    integer

    推定残り実行時間 (秒)。

    説明

    この値は参考用です。実際の実行時間が優先されます。

    0
    Progress

    number

    タスクの完了進捗率 (0.0～100.0)。

    100.0
    RegionId

    string

    リージョン ID。

    cn-beijing
    InstanceType

    string

    リソースタイプ。

    Instance
    InstanceId

    string

    リソース ID。

    pc-2zed3m89cw***
    InstanceName

    string

    リソース名。

    pc-2zed3m89cw***
    DbType

    string

    データベースタイプ。

    polardb_mysql
    Product

    string

    プロダクト。

    polardb
    TaskDetail

    string

    タスク詳細。

    {\"steps\":[{\"step_name\":\"init_task\"},{\"step_name\":\"exec_task\"},{\"step_name\":\"finish_task\"}]}
    ReasonCode

    string

    現在のタスクを開始した理由。

    ""
    ActionInfo

    string

    許可される操作情報。

    説明

    この機能はまだサポートされていません。

    {}
    Uid

    string

    リソースを所有するアカウントの UID。

    1816563541899***
    CallerSource

    string

    リクエスト元。有効な値は次のとおりです。

    • System：システム

    • User：ユーザー

    User
    CallerUid

    string

    リクエスト元のユーザー ID。`CallerSource` が `User` の場合、これはユーザーの UID です。

    1816563541899***

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 1,
  "RequestId": "F90D7C14-2D1C-5B88-9CD1-23AB2CF89***",
  "PageSize": 10,
  "TotalCount": "2",
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mqt8qhnw04ipz0***",
      "CurrentStepName": "finish_task",
      "StartTime": "2025-03-03T07:25:16Z",
      "EndTime": "2025-03-03T07:30:57Z",
      "TaskType": "ChangeVariable",
      "RemainTime": 0,
      "Progress": 100,
      "RegionId": "cn-beijing",
      "InstanceType": "Instance",
      "InstanceId": "pc-2zed3m89cw***",
      "InstanceName": "pc-2zed3m89cw***",
      "DbType": "polardb_mysql",
      "Product": "polardb",
      "TaskDetail": "{\\\"steps\\\":[{\\\"step_name\\\":\\\"init_task\\\"},{\\\"step_name\\\":\\\"exec_task\\\"},{\\\"step_name\\\":\\\"finish_task\\\"}]}",
      "ReasonCode": "\"\"",
      "ActionInfo": "{}",
      "Uid": "1816563541899***",
      "CallerSource": "User",
      "CallerUid": "1816563541899***"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Param.Invalid The parameter is invalid.

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

    変更履歴

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