获取实例任务列表。
调试
您可以在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"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。