取得執行個體任務清單。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
polardbx:DescribeTasks |
get |
*全部資源。
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體名稱。 |
pxc-hzjasd**** |
| StartTime |
string |
是 |
任務開始時間。 |
2021-11-01 |
| EndTime |
string |
是 |
任務結束時間。 |
2021-11-04 |
| PageSize |
integer |
否 |
分頁每頁大小,取值範圍為:5~1000。 |
20 |
| PageNumber |
integer |
否 |
分頁頁數。 |
30 |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
D6045D78-C119-5A17-9DEA-0F810394E008 |
| PageNumber |
integer |
分頁頁數。 |
1 |
| PageRecordCount |
integer |
分頁每頁大小。 |
30 |
| TotalRecordCount |
integer |
分頁總筆數。 |
2 |
| Items |
array<object> |
結果項目清單。 |
|
|
object |
|||
| Status |
string |
任務狀態:
|
RUNNING |
| FinishTime |
string |
任務結束時間,格式為 yyyy-MM-dd'T'HH:mm:ss'Z'。 |
2021-10-20T20:00:00Z |
| Progress |
string |
任務進度,單位 %。 |
80 |
| BeginTime |
string |
任務開始時間,格式為 yyyy-MM-dd'T'HH:mm:ss'Z'。 |
2021-10-20T19:40:00Z |
| TaskErrorCode |
string |
任務失敗的 code。 |
TaskErrorCode |
| DBName |
string |
任務相關的資料庫名稱,一般為空。 |
DBName |
| ProgressInfo |
string |
任務進度詳細情況,一般為空。 |
ProgressInfo |
| ScaleOutToken |
string |
如果是擴容任務,則會有一個擴容 ID,後端唯一鍵。 |
FEA5DC20-6D8A-5979-97AA-FC57546ADC20 |
| TaskId |
string |
任務 ID。 |
20089398 |
| TaskErrorMessage |
string |
任務失敗資訊。 |
TaskErrorMessage |
| TaskAction |
string |
任務 Action,後端任務類型唯一鍵。 |
multi_scale_out |
樣本
正常返回樣本
JSON格式
{
"RequestId": "D6045D78-C119-5A17-9DEA-0F810394E008",
"PageNumber": 1,
"PageRecordCount": 30,
"TotalRecordCount": 2,
"Items": [
{
"Status": "RUNNING",
"FinishTime": "2021-10-20T20:00:00Z",
"Progress": "80",
"BeginTime": "2021-10-20T19:40:00Z",
"TaskErrorCode": "TaskErrorCode",
"DBName": "DBName",
"ProgressInfo": "ProgressInfo",
"ScaleOutToken": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
"TaskId": "20089398",
"TaskErrorMessage": "TaskErrorMessage",
"TaskAction": "multi_scale_out"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。