DescribeTask API Overview for Async Job Status Tracking - Cloud Backup - Alibaba Cloud - Cloud Backup

Queries the status and result of an asynchronous job.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Token	string	No	The access token.	01W3ZZOQ
TaskId	string	No	The ID of the job.	t-*********************
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmvywqfey5njq

Response elements

Element	Type	Description	Example
	object
Progress	integer	The progress of the job, in percentage. Valid values: 0 to 100. A value of -1 indicates that the job failed.	100
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
CompletedTime	integer	The time when the job completed. The value is a UNIX timestamp. Unit: seconds.	1615607706
Result	string	The result of the job.	{}
Description	string	The status of the job. Valid values: created: The job is created. expired: The job has expired. completed: The job is completed. cancelled: The job is canceled.	completed
UpdatedTime	integer	The time when the job was last updated. The value is a UNIX timestamp. Unit: seconds.	1615607706
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
Code	string	The HTTP status code.	200
Message	string	The returned message. The value is "successful" for successful requests, or an error message for failed requests.	successful
Name	string	The name of the job.	InstallBackupClientsTask
CreatedTime	integer	The time when the job was created. The value is a UNIX timestamp. Unit: seconds.	1615607706

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.