调用DescribeTasks接口查看通过API生成的任务(如创建集群)进度详情。
- 支持查看直接使用某API(如CreateDBCluster)生成的任务,或在PolarDB控制台使用某功能(如创建集群)时,系统调用了对应API生成的任务进度详情。
- 当前仅支持查看创建集群时,即调用CreateDBCluster接口且
CreationOption
参数值不为CreateGdnStandby
时,生成的任务进度详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeTasks |
系统规定参数。取值:DescribeTasks。 |
DBClusterId | String | 否 | pc-*************** |
集群ID。 |
DBNodeId | String | 否 | pi-*************** |
节点ID。 |
StartTime | String | 是 | 2020-11-30T00:00Z |
查询开始时间,格式为 |
EndTime | String | 是 | 2020-12-02T03:00Z |
查询结束时间,查询结束时间需晚于开始时间,格式为 |
Status | String | 否 | Running |
任务状态,取值范围如下:
说明
|
PageSize | Integer | 否 | 30 |
每页记录数,取值为30、50或100。 默认值为30。 |
PageNumber | Integer | 否 | 1 |
页码,取值为大于0且不超过Integer数据类型的最大值。 默认值为1。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalRecordCount | Integer | 1 |
总记录数。 |
PageRecordCount | Integer | 30 |
本页记录数。 |
Tasks | Array of Task |
任务详情。 |
|
Task | |||
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 | null |
任务出错时的错误码。 说明 仅当任务状态为Stop时返回该参数。
|
ProgressInfo | String | null |
任务进度的描述信息。若目标任务无进度描述信息,该参数为空。 |
CurrentStepName | String | create_instance |
当前任务的子步骤名称。 |
StepProgressInfo | String | 1/4 |
任务子步骤进度。例如 |
TaskErrorMessage | String | null |
任务出错时的错误信息。 说明 仅当任务状态为Stop时返回该参数。
|
TaskAction | String | CreateDBInstance |
目标任务所使用的API接口,例如 |
DBName | String | test |
数据库名称。 说明 仅涉及数据库相关操作的任务会返回该参数。
|
Remain | Integer | 1767 |
任务预计剩余时间,单位为秒。 |
TaskId | String | 111111111 |
目标任务ID。 |
EndTime | String | 2020-12-02T03:00Z |
查询结束时间。 |
RequestId | String | 4352AD99-9FF5-41A6-A319-068089****** |
请求ID。 |
PageNumber | Integer | 1 |
页码。 |
StartTime | String | 2020-11-30T00:00Z |
查询开始时间。 |
DBClusterId | String | pc-*************** |
任务所对应的集群ID。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeTasks
&EndTime=2020-11-30T00:00Z
&StartTime=2020-12-01T10:00Z
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeTasksResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>30</PageRecordCount>
<Tasks>
<Task>
<StepProgressInfo>1/4</StepProgressInfo>
<Progress>25</Progress>
<TaskId>111111111</TaskId>
<Remain>1767</Remain>
<FinishTime>2020-12-02T02:40:15Z</FinishTime>
<TaskAction>CreateDBInstance</TaskAction>
<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}]</StepsInfo>
<CurrentStepName>create_instance</CurrentStepName>
<BeginTime>2020-12-02T02:39:15Z</BeginTime>
</Task>
</Tasks>
<RequestId>45CE02A1-1766-42E3-9E5F-24B576******</RequestId>
<EndTime>2020-12-02T03:00Z</EndTime>
<PageNumber>1</PageNumber>
<StartTime>2020-11-30T00:00Z</StartTime>
<DBClusterId>pc-*****************</DBClusterId>
</DescribeTasksResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalRecordCount" : 1,
"PageRecordCount" : 30,
"Tasks" : {
"Task" : [ {
"StepProgressInfo" : "1/4",
"Progress" : 25,
"TaskId" : "111111111",
"Remain" : 1767,
"FinishTime" : "2020-12-02T02:40:15Z",
"TaskAction" : "CreateDBInstance",
"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}]",
"CurrentStepName" : "create_instance",
"BeginTime" : "2020-12-02T02:39:15Z"
} ]
},
"RequestId" : "45CE02A1-1766-42E3-9E5F-24B576******",
"EndTime" : "2020-12-02T03:00Z",
"PageNumber" : 1,
"StartTime" : "2020-11-30T00:00Z",
"DBClusterId" : "pc-*****************"
}
错误码
访问错误中心查看更多错误码。