Retrieve Asynchronous Task Details via DescribeTask API - BDRC - Alibaba Cloud - Backup and Disaster Recovery Center

Retrieves the details of an asynchronous task.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bdrc:DescribeTask

none

*All Resource

*

None

Request syntax

GET /api/v1/tasks/{TaskId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the task. You can call the `DescribeTasks` operation to obtain task IDs.	t-0004d9ctt1ii********

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
Data	object	The returned data.
TaskId	string	The ID of the task.	t-xxxxxxxx
TaskName	string	The task name.	test5566
TaskDescription	string	The task description.	empty
TaskType	string	The task type. Valid values: `UPDATE_RESOURCES` (updates resources and their statuses) and `CHECK_RULES`.	UPDATE_RESOURCES
TaskPriority	string	The task priority. Valid values: `HIGH` (typically for user-initiated tasks) and `LOW` (typically for background tasks).	HIGH
RequestId	string	The ID of the request.	784076D6-BD6D-5564-9CEA-834EB11F0C62
TaskDetail	string	The details of the task execution.	{"resourceTypes":["ACS::ECS::Instance","ACS::OSS::Bucket","ACS::OTS::Instance","ACS::NAS::FileSystem"]}
ExecutionId	string	The execution ID. This parameter is deprecated and always returns an empty string.	empty
Progress	integer	The task's progress, measured on a scale of 0 to 10,000.	100
TaskStatus	string	The status of the task. Valid values: `CREATED` (Created), `RUNNING` (Running), `COMPLETE` (Completed), `FAILED` (Failed), `EXPIRED` (Expired), and `CANCELED` (Canceled).	RUNNING
ErrorMessage	string	The error message returned if the task fails.	too many requests.
StartTime	integer	The start time, formatted as a Unix timestamp in seconds.	1724983927
CompleteTime	integer	The completion time, formatted as a Unix timestamp in seconds.	1724983927
ExpireTime	integer	The expiration time, formatted as a Unix timestamp in seconds.	1719026680
TaskResult	string	The result of the task.	{"resourceCounts":[{"resourceType":"ACS::OSS::Bucket","count":2},{"resourceType":"ACS::NAS::FileSystem","count":3}]}
RequestId	string	The ID of the request.	14DFF801-A4E3-5136-AAB8-7D246012CD7A

Examples

Success response

JSON format

{
  "Data": {
    "TaskId": "t-xxxxxxxx",
    "TaskName": "test5566",
    "TaskDescription": " empty",
    "TaskType": "UPDATE_RESOURCES",
    "TaskPriority": "HIGH",
    "RequestId": "784076D6-BD6D-5564-9CEA-834EB11F0C62",
    "TaskDetail": "{\"resourceTypes\":[\"ACS::ECS::Instance\",\"ACS::OSS::Bucket\",\"ACS::OTS::Instance\",\"ACS::NAS::FileSystem\"]}",
    "ExecutionId": " empty",
    "Progress": 100,
    "TaskStatus": "RUNNING",
    "ErrorMessage": "too many requests.",
    "StartTime": 1724983927,
    "CompleteTime": 1724983927,
    "ExpireTime": 1719026680,
    "TaskResult": "{\"resourceCounts\":[{\"resourceType\":\"ACS::OSS::Bucket\",\"count\":2},{\"resourceType\":\"ACS::NAS::FileSystem\",\"count\":3}]}"
  },
  "RequestId": "14DFF801-A4E3-5136-AAB8-7D246012CD7A"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.