DescribeTask - Cloud Backup - Alibaba Cloud Documentation Center

Queries an asynchronous job.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 parameters

Parameter	Type	Description	Example
	object
Progress	integer	The progress of the job. Valid values: 0 to 100. Unit: percentage (%). If the job fails, the value -1 is returned.	100
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
CompletedTime	long	The time when the job was completed. This 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 expires. completed: The job is completed. cancelled: The job is canceled.	completed
UpdatedTime	long	The time when the job was updated. This value is a UNIX timestamp. Unit: seconds.	1615607706
Success	boolean	Indicates whether the call is successful. true: The call is successful. false: The call fails.	true
Code	string	HttpCode	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
Name	string	The name of the job.	InstallBackupClientsTask
CreatedTime	long	The time when the job was created. This value is a UNIX timestamp. Unit: seconds.	1615607706

Examples

Sample success responses

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 Service error codes.

Change history

Change time	Summary of changes	Operation

No change history