All Products
Search
Document Center

Cloud Backup:DescribeTask

Last Updated:Dec 17, 2024

Queries an asynchronous job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hbr:DescribeTaskget
*All Resources
*
    none
none

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 task was complete. The time 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

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 timeSummary of changesOperation
No change history