All Products
Search
Document Center

Hybrid Backup Recovery:DescribeTask

Last Updated:Nov 14, 2022

Queries an asynchronous job.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TokenstringNo

The access token.

01W3ZZOQ
TaskIdstringNo

The ID of the job.

t-*********************
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmvywqfey5njq

Response parameters

ParameterTypeDescriptionExample
object
Progressinteger

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

100
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
CompletedTimelong

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

1615607706
Resultstring

The result of the job.

{}
Descriptionstring

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.
completed
UpdatedTimelong

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

1615607706
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Codestring

HttpCode

200
Messagestring

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

successful
Namestring

The name of the job.

InstallBackupClientsTask
CreatedTimelong

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

1615607706

Example

Request example

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

Normal return example

JSONFormat

{
  "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.