全部產品
Search
文件中心

AnalyticDB:DescribeMaintenanceAction - 查詢營運事件的詳情

更新時間:Feb 26, 2026

調用DescribeMaintenanceAction介面查詢營運事件的詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

adb:DescribeMaintenanceAction

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Region

string

地區。取值如下:

  • 營運事件所在地區的地區 ID,如cn-hangzhou。您可以調用 DescribeRegions 介面查看 AnalyticDB MySQL 版支援的地區和可用性區域資訊,包括地區 ID。

  • 您也可以輸入all查看當前帳號下所有地區下的所有營運事件,當Region設定為all時,TaskType也必須設定為all

cn-hangzhou

TaskType

string

營運事件的類型,取值如下:

  • rds_apsaradb_upgrade:資料庫軟體升級。

  • all:查看當前帳號下所有地區下的所有營運事件,當Region設定為all時,TaskType也必須設定為all

rds_apsaradb_upgrade

IsHistory

integer

指定返回待處理或歷史營運事件的詳情,取值如下:

  • 0:返回待處理營運事件的詳情。

  • 1:返回歷史營運事件的詳情。

若該參數留空,預設返回待處理營運事件的詳情。

1

PageSize

integer

每頁記錄數,取值為 30(預設值)、50100

30

PageNumber

integer

頁碼,取值為大於 0 且不超過 整數資料類型的最大值。預設值為 1

1

RegionId

string

營運事件所在地區的地區 ID。

說明

您可以調用 DescribeRegions 介面查看 AnalyticDB MySQL 版支援的地區和可用性區域資訊,包括地區 ID。

cn-hangzhou

返回參數

名稱

類型

描述

樣本值

object

詳情。

PageNumber

integer

頁碼。

1

RequestId

string

請求 ID。

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

PageSize

integer

每頁記錄數。

30

TotalRecordCount

integer

總記錄數。

2

Items

array<object>

事件列表。

object

詳情。

Status

string

事件狀態。

  • 若您設定IsHistory0,則返回待處理營運事件狀態的詳情,取值範圍如下:
    • WAITING_MODIFY:等待使用者佈建營運事件開始時間。

    • WAITING:營運事件正在等待處理。

    • PROCESSING:營運事件正在處理中(不支援修改處於該狀態下事件的切換時間)。

  • 若您設定IsHistory1,則返回歷史營運事件狀態的詳情,取值範圍如下:
    • SUCCESS:事件結束且執行成功。

    • FAILED:事件結束但執行失敗。

    • CANCEL:事件已取消。

SUCCESS

Deadline

string

營運事件執行時間可調整範圍的最晚時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2021-07-04T15:59:59Z

PrepareInterval

string

營運事件切換之前所需的準備時間,格式為HH:mm:ss

02:00:00

DBType

string

資料庫的引擎類型。

analyticdb

StartTime

string

後台執行該營運事件的時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2021-07-03T04:00:00Z

TaskType

string

營運事件的類型。

rds_apsaradb_upgrade

DBVersion

string

資料庫引擎版本號碼。

3.0

DBClusterId

string

營運事件所涉及叢集的叢集 ID。

am-****************

ModifiedTime

string

修改營運事件切換時間的時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2021-07-03T06:33:00Z

Region

string

營運事件所在地區的地區 ID。

cn-hangzhou

ResultInfo

string

營運事件的執行結果。

說明

僅當Status(狀態)取值為 FAILED(營運事件結束但執行失敗)或 CANCEL(事件已取消)時,返回該參數。

autoCancel

CreatedTime

string

營運事件的建立時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2021-06-30T02:44:27Z

Id

integer

營運事件的 ID。

11111

SwitchTime

string

營運事件預計的切換時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2021-07-03T06:00:00Z

樣本

正常返回樣本

JSON格式

{
  "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 status code

錯誤碼

錯誤資訊

描述

400 RequiredParam.NotFound Required input param is not found.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情