查詢所有定時任務的詳情情況。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Status | string | 否 | 任務狀態，取值范圍如下：
說明
若該參數留空，默認查詢所有狀態的計劃任務。
| finish |
| DBClusterId | string | 否 | 集群 ID。 說明
| pc-************** |
| RegionId | string | 否 | 地域 ID。 說明
| cn-hangzhou |
| PageNumber | integer | 否 | 頁碼，取值為大于 0 且不超過 Integer 數據類型的最大值。默認值為 1。 | 1 |
| PageSize | integer | 否 | 每頁記錄數，取值為 30（默認值）、50 或 100。 | 30 |
| TaskAction | string | 否 | 任務類型，取值范圍如下：
說明
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-************ |
返回參數
示例
正常返回示例
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 無效。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-29 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-09-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |