DescribeTasks

Updated at:

Lists tasks.

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:DescribeTasks

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SitePairId

string

No

ID of the site pair.

s-000cm9ax8sh22u8r9gs0

PageNumber

integer

No

Page number of the paged query.

1

PageSize

integer

No

Number of entries per page.

10

SortBy

string

No

Sort by creation time or update time.

Valid values:

  • updatedTime :

    updatedTime

  • createdTime :

    createdTime

createdTime

Response elements

Element

Type

Description

Example

object

RequestId

string

ID of the request.

86FFBA6E-D087-53E0-8593-4575925CB9DC

Success

boolean

Indicates whether the call succeeded.

True

Code

string

Error code.

200

Message

string

Error message.

successful

PageSize

integer

Number of entries per page.

10

PageNumber

integer

Page number of the paged query.

3

TotalCount

integer

Total number of entries.

53

Tasks

object

task

array<object>

List of tasks.

object

Task list

Progress

integer

Task progress, as a percentage.

90

UpdatedTime

integer

The time when the task was last modified.

1637292645

StatusCode

string

Status of the task.

hdr.task.completed

TargetName

string

Target of the task.

sr-000ftuch27gfuv8wvpyj

Name

string

Name of the task.

CommitFailoverTask

CreatedTime

integer

The time when the task was created.

1636092147

TaskId

string

ID of the task.

t-0007wl5r0hvxrp3c3x8z

Examples

Success response

JSON format

{
  "RequestId": "86FFBA6E-D087-53E0-8593-4575925CB9DC",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 3,
  "TotalCount": 53,
  "Tasks": {
    "task": [
      {
        "Progress": 90,
        "UpdatedTime": 1637292645,
        "StatusCode": "hdr.task.completed",
        "TargetName": "sr-000ftuch27gfuv8wvpyj",
        "Name": "CommitFailoverTask",
        "CreatedTime": 1636092147,
        "TaskId": "t-0007wl5r0hvxrp3c3x8z"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.