Queries an asynchronous backup job.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeTask

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

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

The ID of the backup job.

Response parameters

Parameter Type Example Description
Code String 200

HttpCode

CompletedTime Long 1615607706

The time when the backup job was completed. The time is in the UNIX format. Unit: seconds.

CreatedTime Long 1615607706

The time when the backup job was created. The time is in the UNIX format. Unit: seconds.

Description String completed

The status of the backup job. Valid values:

  • created: The backup job is created.
  • expired: The backup job expires.
  • completed: The backup job is complete.
  • cancelled: The backup job is canceled.
Message String successful

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

Name String InstallBackupClientsTask

The name of the backup job.

Progress Integer 100

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

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

The ID of the request.

Result String {}

The result of the backup job.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.
UpdatedTime Long 1615607706

The time when the backup job was updated. The time is in the UNIX format. Unit: seconds.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeTask
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

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