调用DescribeTasks接口获取实例任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeTasks

系统规定参数。取值：DescribeTasks。
DBInstanceId String 是 pxc-hzjasd****

实例名称。
StartTime String 是 2021-11-01

任务开始时间。
EndTime String 是 2021-11-04

任务结束时间。
PageSize Integer 否 20

分页每页大小，取值范围为：5~1000。
PageNumber Integer 否 30

分页页数。
RegionId String 是 cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String D6045D78-C119-5A17-9DEA-0F810394E008

请求ID。
PageNumber Integer 1

分页页数。
PageRecordCount Integer 30

分页每页大小。
TotalRecordCount Integer 2

分页总共条数。
Items Array of TaskProgressInfo

结果项列表。
Status String RUNNING

任务状态：

  • RUNNING: 任务运行中；
  • FAILED：任务失败中断。
FinishTime String 2021-10-20T20:00:00Z

任务结束时间，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。
Progress String 80

任务进度，单位%。
BeginTime String 2021-10-20T19:40:00Z

任务开始时间，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。
TaskErrorCode String 400

任务失败的code。
DBName String DBName

任务相关的数据库名，一般为空。
ProgressInfo String ProgressInfo

任务进度详细情况，一般为空。
ScaleOutToken String FEA5DC20-6D8A-5979-97AA-FC57546ADC20

如果是扩容任务，则会有一个扩容ID，后台唯一键。
TaskId String 20089398

任务ID。
TaskErrorMessage String xxxxxxx

任务失败信息。
TaskAction String multi_scale_out

任务Action，后端任务类型唯一键。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTasks
&DBInstanceId=pxc-hzjasd****
&StartTime=2021-11-01
&EndTime=2021-11-04
&PageSize=20
&PageNumber=30
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTasksResponse>
    <RequestId>D6045D78-C119-5A17-9DEA-0F810394E008</RequestId>
    <PageNumber>1</PageNumber>
    <PageRecordCount>30</PageRecordCount>
    <TotalRecordCount>2</TotalRecordCount>
    <Items>
        <Status>RUNNING</Status>
        <FinishTime>2021-10-20T20:00:00Z</FinishTime>
        <Progress>80</Progress>
        <BeginTime>2021-10-20T19:40:00Z</BeginTime>
        <TaskErrorCode>400</TaskErrorCode>
        <DBName>DBName</DBName>
        <ProgressInfo>ProgressInfo</ProgressInfo>
        <ScaleOutToken>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</ScaleOutToken>
        <TaskId>20089398</TaskId>
        <TaskErrorMessage>xxxxxxx</TaskErrorMessage>
        <TaskAction>multi_scale_out</TaskAction>
    </Items>
</DescribeTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "400",
    "DBName" : "DBName",
    "ProgressInfo" : "ProgressInfo",
    "ScaleOutToken" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
    "TaskId" : "20089398",
    "TaskErrorMessage" : "xxxxxxx",
    "TaskAction" : "multi_scale_out"
  } ]
}

错误码

访问错误中心查看更多错误码。