调用DescribeTasks查询Redis实例某个时间段内运行的所有任务信息。

在执行某些耗时较长的操作时,您可以调用本接口查询任务的处理进度信息。您也可以通过Redis控制台,进入目标Redis实例的基本信息页面,单击页面右上角的任务进度图标来查看当前任务的处理进度信息。

调试

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

请求参数

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

系统规定的参数,取值:DescribeTasks

StartTime String 2020-11-20T01:00Z

查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。

EndTime String 2020-11-26T01:00Z

查询结束时间,必须晚于查询开始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。

Status String 2

任务状态,传入多个值时使用英文逗号(,)分隔,取值:

  • 0:等待中。
  • 1:执行中。
  • 2:已结束。
  • 4:已关闭。
  • 7:暂停。
  • 8:中断。
InstanceId String r-bp1zxszhcgatnx****

实例ID,可调用DescribeInstances接口获取。

RegionId String cn-hangzhou

实例所属的地域ID,可调用DescribeRegions接口获取。

PageSize Integer 30

每页可展示的记录数,取值: 3050100,默认值为30

PageNumber Integer 1

页码,大于0且不超过Integer数据类型的最大值,默认值为1

返回数据

名称 类型 示例值 描述
Items Array of TaskProgressInfo

任务信息详细列表。

BeginTime String 2020-11-13T06:16:54Z

任务开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

CurrentStepName String init_redis

当前的子步骤名称。

FinishTime String 2020-11-13T06:17:18Z

任务结束时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Progress Float 100

任务进度,单位为百分比。

Remain Integer 60

任务预计剩余时间,单位为秒。

说明 如果任务不处于执行中,不返回本参数或返回的值为0
Status String 2

任务状态。

  • 0:等待中。
  • 1:执行中。
  • 2:已结束。
  • 4:已关闭。
  • 7:暂停。
  • 8:中断。
StepProgressInfo String 3/3

任务的子步骤进度。

说明 如果不存在子步骤,不返回本参数。
StepsInfo String [{\"remain\":0,\"name\":\"init_instance\",\"progress\":100},{\"remain\":107,\"name\":\"init_redis\",\"progress\":12.3},{\"remain\":1881,\"name\":\"init_config\",\"progress\":0}]

子任务步骤信息,格式为JSON。包含该子任务的预计剩余时间(remain)、任务名称(name)和任务进度(progress)信息。

说明 如果不存在子步骤,不返回本参数。
TaskAction String ModifyDBInstanceParameter

任务标识。

TaskId String 32302****

任务ID。

PageNumber Integer 1

页码。

PageSize Integer 30

每页可展示的记录数。

RequestId String 608FAEC9-485E-4C65-82DE-2E5B955E****

请求ID。

TotalRecordCount Integer 2

总记录数。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=DescribeTasks
&StartTime=2020-11-20T01:00Z
&EndTime=2020-11-26T01:00Z
&Status=2
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>

正常返回示例

XML 格式

<DescribeTasksResponse>
      <TotalRecordCount>1</TotalRecordCount>
      <RequestId>5E064E50-5577-4059-BA11-8DCA20DB****</RequestId>
      <PageSize>30</PageSize>
      <PageNumber>1</PageNumber>
      <Items>
            <Status>2</Status>
            <StepProgressInfo>3/3</StepProgressInfo>
            <Progress>100</Progress>
            <TaskId>326497463</TaskId>
            <Remain>0</Remain>
            <FinishTime>2020-11-25T08:48:00Z</FinishTime>
            <TaskAction>CreateDBInstance</TaskAction>
            <StepsInfo>[{"remain":0,"name":"init_instance","progress":100},{"remain":0,"name":"init_redis","progress":100},{"remain":0,"name":"init_config","progress":100}]</StepsInfo>
            <BeginTime>2020-11-25T08:40:07Z</BeginTime>
      </Items>
</DescribeTasksResponse>

JSON 格式

{
	"TotalRecordCount": 1,
	"RequestId": "5E064E50-5577-4059-BA11-8DCA20DB****",
	"PageSize": 30,
	"PageNumber": 1,
	"Items": [
		{
			"Status": "2",
			"StepProgressInfo": "3/3",
			"Progress": 100,
			"TaskId": "326497463",
			"Remain": 0,
			"FinishTime": "2020-11-25T08:48:00Z",
			"TaskAction": "CreateDBInstance",
			"StepsInfo": "[{\"remain\":0,\"name\":\"init_instance\",\"progress\":100},{\"remain\":0,\"name\":\"init_redis\",\"progress\":100},{\"remain\":0,\"name\":\"init_config\",\"progress\":100}]",
			"BeginTime": "2020-11-25T08:40:07Z"
		}
	]
}

错误码

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