查看通過API生成的任務（如創建集群）進度詳情。
接口說明
- 支持查看直接使用某 API（如 CreateDBCluster ）生成的任務，或在 PolarDB 控制臺使用某功能（如創建集群）時，系統調用了對應 API 生成的任務進度詳情。
- 當前僅支持查看創建集群時，即調用 CreateDBCluster 接口且
CreationOption參數值不為CreateGdnStandby時，生成的任務進度詳情。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| polardb:DescribeTasks | Read |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 否 | 集群 ID。 說明
DBNodeId和DBClusterId必選其一填入。您可以通過 DescribeDBClusters 接口查看賬號下所有集群的詳細信息，包括集群 ID。
| pc-*************** |
| DBNodeId | string | 否 | 節點 ID。 說明
DBNodeId和DBClusterId必選其一填入。您可以通過 DescribeDBClusters 接口查看賬號下所有集群的詳細信息，包括節點 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 且不超過 Integer 數據類型的最大值。 默認值為 1。 | 1 |
返回參數
示例
正常返回示例
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無效。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2023-09-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||
|