DescribeTask

Updated at:

Queries the details of a 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

hdr:DescribeTask

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

TaskId

string

Yes

The task ID.

t-0005qxusucbnl5efovq9

Response elements

Element

Type

Description

Example

object

Progress

integer

The task progress, in percent.

100

Success

boolean

Indicates whether the task is successful.

True

Message

string

The error message.

successful

RequestId

string

The request ID.

8F8A2274-F2A5-5782-89A0-7FA442BFA16B

UpdatedTime

integer

The time when the task was last updated.

1636452195

StatusCode

string

The status of the task.

hdr.task.TestFailoverTask.waitStartFailover

Code

string

The return code.

200

Name

string

The name of the task.

hdr.task.name.TestFailoverTask

TaskId

string

The task ID.

t-000bzkmmlwh57miq4mwh

Content

string

The content of the task.

-

CreatedTime

integer

The time when the task was created.

1646100927

Examples

Success response

JSON format

{
  "Progress": 100,
  "Success": true,
  "Message": "successful",
  "RequestId": "8F8A2274-F2A5-5782-89A0-7FA442BFA16B",
  "UpdatedTime": 1636452195,
  "StatusCode": "hdr.task.TestFailoverTask.waitStartFailover",
  "Code": "200",
  "Name": "hdr.task.name.TestFailoverTask",
  "TaskId": "t-000bzkmmlwh57miq4mwh",
  "Content": "-",
  "CreatedTime": 1646100927
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.