すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeMaintenanceAction

    ドキュメントセンター

    AnalyticDB:DescribeMaintenanceAction

    最終更新日:Feb 26, 2026

    O&M イベントの情報を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeMaintenanceAction

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Region

    string

    必須

    リージョン ID。有効な値は以下のとおりです。

    • O&M イベントが発生するリージョンの ID。例： cn-hangzhou。最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出します。

    • すべてのリージョンにおける O&M イベントを照会するには、Region を all に設定できます。ただし、Region を all に設定する場合は、TaskType も all に設定する必要があります。

    cn-hangzhou
    TaskType

    string

    必須

    O&M イベントの種類。有効な値は以下のとおりです。

    • rds_apsaradb_upgrade：データベースソフトウェアのアップグレード。

    • all：現在のアカウントで、すべてのリージョンにおけるすべての O&M イベント。ただし、Region を all に設定する場合は、TaskType も all に設定する必要があります。

    rds_apsaradb_upgrade
    IsHistory

    integer

    任意

    保留中の O&M イベントまたは履歴 O&M イベントの情報を返すかどうかを指定します。有効な値は以下のとおりです。

    • 0：保留中の O&M イベントの情報を返します。

    • 1：履歴 O&M イベントの情報を返します。

    このパラメーターを指定しない場合、保留中の O&M イベントの情報が返されます。

    1
    PageSize

    integer

    任意

    1 ページあたりの表示件数。有効な値は 30、50、100 です。デフォルト値は 30 です。

    30
    PageNumber

    integer

    任意

    ページ番号。1 から始まります。デフォルト値は 1 です。

    1
    RegionId

    string

    必須

    O&M イベントが発生するリージョンの ID。

    説明

    最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出します。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    PageNumber

    integer

    ページ番号。

    1
    RequestId

    string

    リクエスト ID。

    E774C8A9-8819-4A09-9E91-07C078******
    PageSize

    integer

    1 ページあたりの表示件数。

    30
    TotalRecordCount

    integer

    返された合計件数。

    2
    Items

    array<object>

    照会された O&M イベント。

    object

    Status

    string

    イベントの状態。

    • IsHistory を 0 に設定した場合、保留中の O&M イベントの状態が返されます。有効な値は以下のとおりです。

      • WAITING_MODIFY：O&M イベントの開始時刻の設定待ち。

      • WAITING：O&M イベントの処理待ち。

      • PROCESSING：O&M イベントの実行中。この状態のイベントのスイッチオーバー時刻は変更できません。

    • IsHistory を 1 に設定した場合、履歴 O&M イベントの状態が返されます。有効な値は以下のとおりです。

      • SUCCESS：イベントが正常終了し、実行に成功しました。

      • FAILED：イベントが終了しましたが、実行に失敗しました。

      • CANCEL：イベントがキャンセルされました。

    SUCCESS
    Deadline

    string

    イベント実行の期限。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記され、UTC 時間で表示されます。

    2021-07-04T15:59:59Z
    PrepareInterval

    string

    保留中の O&M イベントのスイッチオーバーに必要な準備時間。形式は HH:mm:ss です。

    02:00:00
    DBType

    string

    データベースエンジン。

    analyticdb
    StartTime

    string

    タスクがバックエンドで実行された時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記され、UTC 時間で表示されます。

    2021-07-03T04:00:00Z
    TaskType

    string

    O&M イベントの種類。

    rds_apsaradb_upgrade
    DBVersion

    string

    データベースエンジンのバージョン。

    3.0
    DBClusterId

    string

    O&M イベントに関連するクラスターの ID。

    am-****************
    ModifiedTime

    string

    O&M イベントのスイッチオーバー時刻が変更された時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記され、UTC 時間で表示されます。

    2021-07-03T06:33:00Z
    Region

    string

    O&M イベントが発生するリージョンの ID。

    cn-hangzhou
    ResultInfo

    string

    O&M イベントの実行結果。

    説明

    Status の値が FAILED または CANCEL の場合のみ、このパラメーターが返されます。

    autoCancel
    CreatedTime

    string

    O&M イベントが作成された時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記され、UTC 時間で表示されます。

    2021-06-30T02:44:27Z
    Id

    integer

    O&M イベントの ID。

    11111
    SwitchTime

    string

    保留中の O&M イベントのスイッチオーバー時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記され、UTC 時間で表示されます。

    2021-07-03T06:00:00Z

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 1,
  "RequestId": "E774C8A9-8819-4A09-9E91-07C078******",
  "PageSize": 30,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "SUCCESS",
      "Deadline": "2021-07-04T15:59:59Z",
      "PrepareInterval": "02:00:00",
      "DBType": "analyticdb",
      "StartTime": "2021-07-03T04:00:00Z",
      "TaskType": "rds_apsaradb_upgrade",
      "DBVersion": "3.0",
      "DBClusterId": "am-****************",
      "ModifiedTime": "2021-07-03T06:33:00Z",
      "Region": "cn-hangzhou",
      "ResultInfo": "autoCancel",
      "CreatedTime": "2021-06-30T02:44:27Z",
      "Id": 11111,
      "SwitchTime": "2021-07-03T06:00:00Z"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 RequiredParam.NotFound Required input param is not found.

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

    変更履歴

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