查看通过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 且不超过 Integer 数据类型的最大值。 默认值为 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无效。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。