查看通過API產生的任務（如建立叢集）進度詳情。
介面說明
支援查看直接使用某 API（如 CreateDBCluster ）產生的任務，或在 PolarDB 控制台使用某功能（如建立叢集）時，系統調用了對應 API 產生的任務進度詳情。
當前僅支援查看建立叢集時，即調用 CreateDBCluster 介面且
CreationOption參數值不為CreateGdnStandby時，產生的任務進度詳情。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
polardb:DescribeTasks |
get |
*dbcluster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBClusterId |
string |
否 |
叢集 ID。 說明
|
pc-*************** |
| DBNodeId |
string |
否 |
節點 ID。 說明
|
pi-*************** |
| StartTime |
string |
是 |
查詢開始時間，格式為 |
2020-11-30T00:00Z |
| EndTime |
string |
是 |
查詢結束時間，查詢結束時間需晚於開始時間，格式為 |
2020-12-02T03:00Z |
| Status |
string |
否 |
任務狀態，取值範圍如下：
說明
|
Running |
| PageSize |
integer |
否 |
每頁記錄數，取值為 30、50 或 100。 預設值為 30。 |
30 |
| PageNumber |
integer |
否 |
頁碼，取值為大於 0 且不超過 整數資料類型的最大值。 預設值為 1。 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| TotalRecordCount |
integer |
總記錄數。 |
1 |
| PageRecordCount |
integer |
本頁記錄數。 |
30 |
| Tasks |
object |
||
| Task |
array<object> |
任務詳情。 |
|
|
object |
|||
| FinishTime |
string |
任務完成時間，格式為 |
2020-12-02T02:40:15Z |
| StepsInfo |
string |
任務子步驟詳情。 |
[{\"remain\":0,\"name\":\"init_task\",\"progress\":100},{\"remain\":1764,\"name\":\"create_instance\",\"progress\":0},{\"remain\":1,\"name\":\"init_cluster\",\"progress\":0},{\"remain\":2,\"name\":\"create_backup\",\"progress\":0}] |
| Progress |
integer |
任務進度百分比。 |
100 |
| ExpectedFinishTime |
string |
預計結束時間。若無特殊情況，該參數為空白。 |
null |
| BeginTime |
string |
任務開始時間，格式為 |
2020-12-02T02:39:15Z |
| TaskErrorCode |
string |
任務出錯時的錯誤碼。 說明
僅當任務狀態為 Stop 時返回該參數。 |
null |
| ProgressInfo |
string |
任務進度的描述資訊。若目標任務無進度描述資訊，該參數為空白。 |
null |
| CurrentStepName |
string |
當前任務的子步驟名稱。 |
create_instance |
| StepProgressInfo |
string |
任務子步驟進度。例如 |
1/4 |
| TaskErrorMessage |
string |
任務出錯時的錯誤資訊。 說明
僅當任務狀態為 Stop 時返回該參數。 |
null |
| TaskAction |
string |
目標任務所使用的 API 介面，例如 |
CreateDBInstance |
| DBName |
string |
資料庫名稱。 說明
僅涉及資料庫相關操作的任務會返回該參數。 |
test |
| Remain |
integer |
任務預計剩餘時間，單位為秒。 |
1767 |
| TaskId |
string |
目標任務 ID。 |
111111111 |
| EndTime |
string |
查詢結束時間。 |
2020-12-02T03:00Z |
| RequestId |
string |
請求 ID。 |
4352AD99-9FF5-41A6-A319-068089****** |
| PageNumber |
integer |
頁碼。 |
1 |
| StartTime |
string |
查詢開始時間。 |
2020-11-30T00:00Z |
| DBClusterId |
string |
任務所對應的叢集 ID。 |
pc-*************** |
樣本
正常返回樣本
JSON格式
{
"TotalRecordCount": 1,
"PageRecordCount": 30,
"Tasks": {
"Task": [
{
"FinishTime": "2020-12-02T02:40:15Z",
"StepsInfo": "[{\\\"remain\\\":0,\\\"name\\\":\\\"init_task\\\",\\\"progress\\\":100},{\\\"remain\\\":1764,\\\"name\\\":\\\"create_instance\\\",\\\"progress\\\":0},{\\\"remain\\\":1,\\\"name\\\":\\\"init_cluster\\\",\\\"progress\\\":0},{\\\"remain\\\":2,\\\"name\\\":\\\"create_backup\\\",\\\"progress\\\":0}]",
"Progress": 100,
"ExpectedFinishTime": "null",
"BeginTime": "2020-12-02T02:39:15Z",
"TaskErrorCode": "null",
"ProgressInfo": "null",
"CurrentStepName": "create_instance",
"StepProgressInfo": "1/4",
"TaskErrorMessage": "null",
"TaskAction": "CreateDBInstance",
"DBName": "test",
"Remain": 1767,
"TaskId": "111111111"
}
]
},
"EndTime": "2020-12-02T03:00Z",
"RequestId": "4352AD99-9FF5-41A6-A319-068089******",
"PageNumber": 1,
"StartTime": "2020-11-30T00:00Z",
"DBClusterId": "pc-***************"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidDBNodeId.Malformed | The specified parameter DBNodeId is not valid. | 指定的參數DBNodeId無效。 |
| 400 | InvalidStartTime.Malformed | The specified parameter StartTime is not valid. | 指定的參數StartTime無效 |
| 400 | InvalidEndTime.Malformed | The specified parameter EndTime is not valid. | 指定的參數EndTime無效 |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | 指定的參數PageSize無效 |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | 指定的參數PageNumber無效 |
| 400 | InvalidStatus.Malformed | The specified parameter Status is not valid. | 指定的參數Status無效。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。