DescribeActiveOperationTask - 查詢營運任務詳情 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體的營運任務詳情。

介面說明

調用本介面查詢到當前有營運任務後，您還可以調用 ModifyActiveOperationTask 修改營運任務的計劃切換時間。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeActiveOperationTask

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Region	string	是	待處理事件所屬的地區 ID，可調用 DescribeRegions 介面擷取。說明取值為 all 表示所有地區 ID。	all
TaskType	string	是	任務類型，取值： rds_apsaradb_ha：主備節點切換。 rds_apsaradb_transfer：執行個體遷移。 rds_apsaradb_upgrade：小版本升級。	rds_apsaradb_ha
IsHistory	integer	否	是否返回歷史任務，取值： 0：預設值，返回當前任務。 1：返回歷史任務。	1
PageSize	integer	否	每頁可展示的最大記錄數，取值需大於 10，預設值為 30。	30
PageNumber	integer	否	頁碼，大於 0 且不超過整數資料類型的最大值，預設值為 1。	1

返回參數

名稱	類型	描述	樣本值
	object
PageNumber	integer	頁碼。	1
RequestId	string	請求 ID。	2E1FF0CC-F42A-4B6F-A1F4-A17B1451****
PageSize	integer	每頁可展示的最大記錄數。	30
TotalRecordCount	integer	總記錄數。	1
Items	array<object>	營運工作清單。
	object
Status	integer	任務狀態，傳回值： 2：等待使用者指定時間。 3：等待處理。 4：處理中。進入此狀態後，不可調用 ModifyActiveOperationTask 修改計劃切換時間。 5：成功。 6：失敗。 7：已取消。	5
Deadline	string	營運任務執行時間可調整範圍的最晚期時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2023-03-29T13:59:59Z
PrepareInterval	string	營運任務開始時間到切換時間之間所需的準備時間，格式為HH:mm:ss。	14:00:00
TaskType	string	任務類型，傳回值： rds_apsaradb_ha：主備節點切換。 rds_apsaradb_transfer：執行個體遷移。 rds_apsaradb_upgrade：小版本升級。 all：所有任務類型。	rds_apsaradb_upgrade
StartTime	string	營運任務執行的時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2023-03-20T02:40:00Z
ModifiedTime	string	營運任務修改時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2023-02-24T08:18:53Z
InsName	string	執行個體 ID。	r-bp1lgal1sdvxrz****
DbType	string	資料庫類型，傳回值：redis。	redis
Region	string	地區 ID。	cn-hanghzou
CreatedTime	string	營運任務的建立時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2023-02-24T06:00:11Z
Id	integer	營運任務 ID。	1****1
SwitchTime	string	系統發起的切換操作的時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2023-03-20T03:10:00Z

樣本

正常返回樣本

JSON格式

{
  "PageNumber": 1,
  "RequestId": "2E1FF0CC-F42A-4B6F-A1F4-A17B1451****",
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 5,
      "Deadline": "2023-03-29T13:59:59Z",
      "PrepareInterval": "14:00:00",
      "TaskType": "rds_apsaradb_upgrade",
      "StartTime": "2023-03-20T02:40:00Z",
      "ModifiedTime": "2023-02-24T08:18:53Z",
      "InsName": "r-bp1lgal1sdvxrz****",
      "DbType": "redis",
      "Region": "cn-hanghzou",
      "CreatedTime": "2023-02-24T06:00:11Z",
      "Id": 0,
      "SwitchTime": "2023-03-20T03:10:00Z"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	RequiredParam.NotFound	Required input param is not found.	缺少輸入參數

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

變更歷史

更多資訊，參考變更詳情。