查看通过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 错误码发生变更 | 看变更集 | ||||
|