DescribeTasks

You can call this operation to query the progress of a task when you perform time-consuming operations. You can also log on to the ApsaraDB for Redis console and click the Tasks icon in the upper-right corner of the Instance Information page to view the progress of the current task.

Request parameters

Response parameters

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeTasks
&StartTime=2020-11-20T01:00Z
&EndTime=2020-11-26T01:00Z
&Status=2
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

<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 format

{
	"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"
		}
	]
}

Error codes

For a list of error codes, visit the API Error Center.