Queries an asynchronous job.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeTask

The operation that you want to perform. Set the value to DescribeTask.

Token String No 01W3ZZOQ

The access token.

TaskId String No t-*********************

The ID of the job.

ResourceGroupId String No rg-acfmvywqfey5njq

The ID of the resource group.

Response parameters

Parameter Type Example Description
Progress Integer 100

The progress of the job. Valid values: 0 to 100. Unit: percentage (%). If the job fails, the value -1 is returned.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

CompletedTime Long 1615607706

The time when the job was completed. This value is a UNIX timestamp. Unit: seconds.

Result String {}

The result of the job.

Description String completed

The status of the job. Valid values:

  • created: The job is created.
  • expired: The job expires.
  • completed: The job is completed.
  • cancelled: The job is canceled.
UpdatedTime Long 1615607706

The time when the job was updated. This value is a UNIX timestamp. Unit: seconds.

Success Boolean true

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
Code String 200

HttpCode
Message String successful

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

Name String InstallBackupClientsTask

The name of the job.

CreatedTime Long 1615607706

The time when the job was created. This value is a UNIX timestamp. Unit: seconds.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeTask
&Token=01W3ZZOQ
&TaskId=t-*********************
&ResourceGroupId=rg-acfmvywqfey5njq
&Common request parameters

Sample success responses

XML format 

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

<DescribeTaskResponse>
    <Progress>100</Progress>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <CompletedTime>1615607706</CompletedTime>
    <Result>{}</Result>
    <Description>completed</Description>
    <UpdatedTime>1615607706</UpdatedTime>
    <Success>true</Success>
    <Code>200</Code>
    <Message>successful</Message>
    <Name>InstallBackupClientsTask</Name>
    <CreatedTime>1615607706</CreatedTime>
</DescribeTaskResponse>

JSON format 

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

{
  "Progress" : 100,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "CompletedTime" : 1615607706,
  "Result" : "{}",
  "Description" : "completed",
  "UpdatedTime" : 1615607706,
  "Success" : true,
  "Code" : "200",
  "Message" : "successful",
  "Name" : "InstallBackupClientsTask",
  "CreatedTime" : 1615607706
}

Error codes

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