DescribeActiveOperationTasks - 查詢多個主動營運任務資訊

更新時間:
Copy as MD

查詢執行個體的營運事件詳情。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeActiveOperationTasks

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

待處理事件所屬的地區 ID。

說明

您可以通過 DescribeRegions 介面查看可用地區。

cn-beijing

TaskType

string

待處理事件的任務類型,取值範圍如下:

  • DatabaseSoftwareUpgrading:資料庫軟體升級

  • DatabaseHardwareMaintenance:硬體維護與升級

  • DatabaseStorageUpgrading:資料庫儲存升級

  • DatabaseProxyUpgrading:代理小版本升級

  • all:表示查詢上述所有類型的待處理事件詳情

說明

Region設定為 all 時,TaskType也必須設定為 all

DatabaseProxyUpgrading

PageSize

integer

每頁記錄數,取值範圍如下:

  • 30(預設)

  • 50

  • 100

30

PageNumber

integer

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

1

DBType

string

資料庫引擎類型。取值範圍如下:

  • MySQL

  • PostgreSQL

  • Oracle

MySQL

Status

integer

任務狀態。取值範圍如下:

  • -1:全部任務。

  • 3:待處理任務。

  • 4:處理中任務。

  • 5:成功結束任務。

  • 6:失敗結束任務。

  • 7:已取消任務。

-1

DBClusterId

string

叢集 ID。

說明

您可以通過 DescribeDBClusters 介面查看帳號下所有叢集的詳細資料,包括叢集 ID。

pc-3ns***********d5d

AllowChange

integer

是否允許修改時間。取值範圍如下:

  • -1(預設):全部。

  • 0:只返回不允許修改時間的任務。

  • 1:只返回允許修改時間的任務。

-1

AllowCancel

integer

是否允許取消。取值範圍如下:

  • -1(預設):全部。

  • 0:只返回不允許取消的任務。

  • 1:只返回允許取消的任務。

-1

ChangeLevel

string

任務層級。取值範圍如下:

  • all(預設):全部。

  • S0:返回異常修複層級的任務。

  • S1:返回系統營運層級的任務。

all

返回參數

名稱

類型

描述

樣本值

object

TotalRecordCount

integer

返回的任務記錄數。

1

RequestId

string

請求 ID。

FAF88508-D5F8-52B1-8824-262601769E31

PageSize

integer

每頁記錄數,取值範圍:

  • 30

  • 50

  • 100

預設值為 30

30

PageNumber

integer

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

1

Items

array<object>

營運工作清單。

object

營運工作清單。

Status

integer

任務狀態。取值範圍如下:

  • 0:表示等待通知。

  • 1:表示重試通知。

  • 2:表示等待使用者指定時間。

  • 3:表示等待處理。

  • 4:表示處理中。

  • 5:表示成功結束。

  • 6:表示失敗結束。

  • 7:已取消。

3

PrepareInterval

string

開始時間到切換時間之間所需的準備時間。格式為 HH:mm:ss。

04:00:00

Deadline

string

任務執行時間可調整範圍的最晚期限。格式為:YYYY-MM-DDTHH:mm:ssZ。

2020-06-11T15:59:59Z

DBType

string

資料庫引擎類型,取值範圍如下:

  • MySQL

  • PostgreSQL

  • Oracle

MySQL

TaskType

string

待處理事件的任務類型,取值範圍如下:

  • DatabaseSoftwareUpgrading:資料庫軟體升級。

  • DatabaseHardwareMaintenance:硬體維護與升級。

  • DatabaseStorageUpgrading:資料庫儲存升級。

  • DatabaseProxyUpgrading:代理小版本升級。

  • all:表示查詢上述所有類型的待處理事件詳情。

DatabaseSoftwareUpgrading

StartTime

string

後台執行任務的時間點。格式為:YYYY-MM-DDTHH:mm:ssZ。

2023-05-19T02:48:17Z

DBVersion

string

核心版本號碼。

8.0

ModifiedTime

string

修改時間。格式為:YYYY-MM-DDTHH:mm:ssZ。

2020-06-09T22:00:42Z

DBClusterId

string

叢集 ID。

pc-*****************

Region

string

地區代碼。

cn-hangzhou

ResultInfo

string

執行結果資訊。

userCancel

CreatedTime

string

建立時間。格式為:YYYY-MM-DDTHH:mm:ssZ。

2020-06-09T22:00:42Z

TaskId

integer

任務 ID。

107202351

SwitchTime

string

後台發起切換操作的時間點。格式為:YYYY-MM-DDTHH:mm:ssZ。

2020-06-09T22:00:00Z

CurrentAVZ

string

當前可用性區域。

cn-beijing-h

InsComment

string

叢集別名,叢集備忘。

test

TaskTypeZh

string

任務原因中文。

小版本升級

TaskTypeEn

string

任務原因英文。

Minor version update

ChangeLevel

string

事件等級代碼。取值範圍如下:

  • S1:系統營運。

  • S0:風險修複。

S0

ChangeLevelZh

string

事件等級(中文)。

系統營運

ChangeLevelEn

string

事件等級(英文)。

System maintenance

ImpactZh

string

事件影響(中文)。

叢集閃斷

ImpactEn

string

事件影響(英文)。

Transient instance disconnection

AllowChange

integer

是否允許修改時間。取值範圍如下:

  • 1:表示允許使用者修改時間。

  • 0:表示不允許使用者修改時間。

0

AllowCancel

integer

是否允許取消。取值範圍如下:

  • 1:表示允許使用者取消任務。

  • 0:表示不允許取消。

0

Impact

string

事件影響。

TransientDisconnection

DBNodeIds

array

節點 id 列表。

string

節點 ID。支援傳入多個節點 ID,多個 ID 間用英文逗號(,)分隔。

pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i

TaskParams

string

任務參數。

{ "Action": "UpgradeDBInstance" }

樣本

正常返回樣本

JSON格式

{
  "TotalRecordCount": 1,
  "RequestId": "FAF88508-D5F8-52B1-8824-262601769E31",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 3,
      "PrepareInterval": "04:00:00",
      "Deadline": "2020-06-11T15:59:59Z",
      "DBType": "MySQL",
      "TaskType": "DatabaseSoftwareUpgrading",
      "StartTime": "2023-05-19T02:48:17Z",
      "DBVersion": "8.0",
      "ModifiedTime": "2020-06-09T22:00:42Z",
      "DBClusterId": "pc-*****************",
      "Region": "cn-hangzhou",
      "ResultInfo": "userCancel",
      "CreatedTime": "2020-06-09T22:00:42Z",
      "TaskId": 107202351,
      "SwitchTime": "2020-06-09T22:00:00Z",
      "CurrentAVZ": "cn-beijing-h",
      "InsComment": "test",
      "TaskTypeZh": "小版本升級",
      "TaskTypeEn": "Minor version update",
      "ChangeLevel": "S0",
      "ChangeLevelZh": "系統營運",
      "ChangeLevelEn": "System maintenance",
      "ImpactZh": "叢集閃斷",
      "ImpactEn": "Transient instance disconnection",
      "AllowChange": 0,
      "AllowCancel": 0,
      "Impact": "TransientDisconnection",
      "DBNodeIds": [
        "pi-t4n***********0ni,pi-t4n***********334,pi-t4n***********h07,pi-t4n***********q5i"
      ],
      "TaskParams": "{\n      \"Action\": \"UpgradeDBInstance\"\n}"
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidPageParam.Format Page param should be a positive integer. 頁參數應為正整數,請檢查後重新設定。
400 RequiredParam.NotFound Required input param is not found. 所需的輸入參數不存在。

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

變更歷史

更多資訊,參考變更詳情