DescribeScheduleTasks - 查詢定時任務詳情 -

查詢所有定時任務的詳情情況。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeScheduleTasks

get

*DBCluster

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

無

請求參數

名稱	類型	必填	描述	樣本值
Status	string	否	任務狀態，取值範圍如下： pending：等待執行中 executing：執行中 failure：執行失敗待重試 finish：已完成 cancel：已取消 expired：超期（即未在計劃時間段內開始執行目標任務） rollback：復原中說明若該參數留空，預設查詢所有狀態的計劃任務。	finish
DBClusterId	string	否	叢集 ID。說明您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊，包括叢集 ID。若該參數留空，預設查詢當前帳號下所有叢集的計劃任務。	pc-**************
RegionId	string	否	地區 ID。說明您可以調用 DescribeRegions 介面查看目標帳號下所有的叢集的地區資訊。若該參數留空，預設查詢當前帳號下所有地區內的計劃任務。	cn-hangzhou
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的最大值。預設值為 1。	1
PageSize	integer	否	每頁記錄數，取值為 30（預設值）、50 或 100。	30
TaskAction	string	否	任務類型，取值範圍如下： CreateDBNodes ModifyDBNodeClass UpgradeDBClusterVersion ModifyDBClusterPrimaryZone 說明僅當調用上述介面時指定了`PlannedStartTime`參數值，會返回目標任務的詳情，否則`TimerInfos`為空白。若該參數留空，預設查詢當前帳號下所有類型的計劃任務。	CreateDBNodes
DBClusterDescription	string	否	叢集描述。	testdb
OrderId	string	否	訂單 ID。說明僅支援傳入數字 0~9。	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	營運定時任務 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
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

樣本

正常返回樣本

JSON格式

{
  "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": "",
        "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 status code	錯誤碼	錯誤資訊	描述
400	InvalidOrderId.Malformed	The specified parameter OrderId is not valid.	指定的訂單 ID 無效。

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

變更歷史

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