すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeScheduleTasks

    ドキュメントセンター

    PolarDB:DescribeScheduleTasks

    最終更新日:Apr 17, 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:DescribeScheduleTasks

    get

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Status

    string

    任意

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

    • pending：タスクは実行待機中です。

    • executing：タスクは実行中です。

    • failure：タスクは失敗し、リトライを待機しています。

    • finish：タスクは完了しました。

    • cancel：タスクはキャンセルされました。

    • expired：スケジュールされた時間枠内に開始されなかったため、タスクは期限切れになりました。

    • rollback：タスクはロールバック中です。

    説明

    このパラメーターを省略した場合、すべてのステータスの定期タスクがクエリされます。

    finish
    DBClusterId

    string

    任意

    クラスター ID。

    説明

    • DescribeDBClusters API オペレーションを呼び出して、特定のリージョン内のすべてのクラスターの詳細 (クラスター ID を含む) をクエリできます。

    • このパラメーターを省略した場合、アカウント内のすべてのクラスターの定期タスクがクエリされます。

    pc-**************
    RegionId

    string

    任意

    リージョン ID。

    説明

    • DescribeRegions API オペレーションを呼び出して、利用可能なリージョンをクエリできます。

    • このパラメーターを省略した場合、アカウント内のすべてのリージョンの定期タスクがクエリされます。

    cn-hangzhou
    PageNumber

    integer

    任意

    返すページ番号。0 より大きい整数である必要があります。デフォルト値：1。

    1
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効な値：30 (デフォルト)、50、100。

    30
    TaskAction

    string

    任意

    定期タスクの操作。有効な値：

    • CreateDBNodes

    • ModifyDBNodeClass

    • UpgradeDBClusterVersion

    • ModifyDBClusterPrimaryZone

    説明

    • 上記の API オペレーションのいずれかを呼び出すときに PlannedStartTime パラメーターを指定した場合にのみ、タスクの詳細が返されます。それ以外の場合、応答の TimerInfos フィールドは空になります。

    • このパラメーターを省略した場合、すべてのタイプの定期タスクがクエリされます。

    CreateDBNodes
    DBClusterDescription

    string

    任意

    クラスターの説明。

    testdb
    OrderId

    string

    任意

    注文 ID。

    説明

    注文 ID には数字のみを含めることができます。

    20951253014****
    PlannedStartTime

    string

    任意

    タスクの最も早い開始時刻。時刻は協定世界時 (UTC) です。

    2021-01-28T12:00Z
    PlannedEndTime

    string

    任意

    タスクの最も遅い開始時刻。時刻は協定世界時 (UTC) です。この時刻までにタスクが開始されない場合、タスクは期限切れになります。

    2021-01-28T12:30Z
    ResourceGroupId

    string

    任意

    リソースグループ ID。

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Data

    object

    結果セット。

    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

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

    30
    TimerInfos

    array<object>

    定期タスクの詳細。

    object

    Action

    string

    タスクタイプ。

    CreateDBNodes
    CrontabJobId

    string

    定期的な O&M タスクの ID。

    86293c29-a03d-4872-b625-***********
    DBClusterId

    string

    クラスター ID。

    pc-**************
    DbClusterDescription

    string

    クラスターの説明。

    test_cluster
    DbClusterStatus

    string

    クラスターのステータス。

    Running
    OrderId

    string

    注文 ID。

    説明

    このパラメーターは、Action が CreateDBNodes または ModifyDBNodeClass の場合にのみ返されます。

    208161753******
    PlannedEndTime

    string

    タスクの最も遅い開始時刻。時刻は協定世界時 (UTC) です。

    2021-01-28T12:30Z
    PlannedFlashingOffTime

    string

    一時的なスイッチオーバーのスケジュールされた時刻。

    2021-01-28T12:30Z
    PlannedStartTime

    string

    タスクのスケジュールされた開始時刻。時刻は協定世界時 (UTC) です。

    2021-01-28T12:00Z
    PlannedTime

    string

    タスクの推定開始時刻。時刻は協定世界時 (UTC) です。

    2021-01-28T12:16Z
    Region

    string

    タスクのリージョン ID。

    cn-hangzhou
    Status

    string

    タスクのステータス。

    finish
    TaskCancel

    boolean

    定期タスクをキャンセルできるかどうかを示します。有効な値：

    • true

    • false

    true
    TaskId

    string

    タスク ID。

    53879cdb-9a00-428e-acaf-ff4cff******
    TotalRecordCount

    integer

    エントリの総数。

    1
    Message

    string

    応答メッセージ。

    説明

    リクエストが成功した場合、Successful が返されます。それ以外の場合は、エラーメッセージが返されます。

    Successful
    RequestId

    string

    リクエスト ID。

    936C7025-27A5-4CB1-BB31-540E1F0CCA12
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TimerInfos": [
      {
        "Action": "CreateDBNodes",
        "CrontabJobId": "86293c29-a03d-4872-b625-***********",
        "DBClusterId": "pc-**************",
        "DbClusterDescription": "test_cluster",
        "DbClusterStatus": "Running",
        "OrderId": "208161753******",
        "PlannedEndTime": "2021-01-28T12:30Z",
        "PlannedFlashingOffTime": "2021-01-28T12:30Z",
        "PlannedStartTime": "2021-01-28T12:00Z",
        "PlannedTime": "2021-01-28T12:16Z",
        "Region": "cn-hangzhou",
        "Status": "finish",
        "TaskCancel": true,
        "TaskId": "53879cdb-9a00-428e-acaf-ff4cff******"
      }
    ],
    "TotalRecordCount": 1
  },
  "Message": "Successful",
  "RequestId": "936C7025-27A5-4CB1-BB31-540E1F0CCA12",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidOrderId.Malformed The specified parameter OrderId is not valid.

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

    変更履歴

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