DescribeTasks - PolarDB - Alibaba Cloud Documentation Center

Retrieves the task list of an instance.

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

polardbx:DescribeTasks

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance name.	pxc-hzjasd****
StartTime	string	Yes	The start time of the task.	2021-11-01
EndTime	string	Yes	The end time of the task.	2021-11-04
PageSize	integer	No	The number of entries per page. Valid values: 5 to 1000.	20
PageNumber	integer	No	The page number.	30
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D6045D78-C119-5A17-9DEA-0F810394E008
PageNumber	integer	The page number.	1
PageRecordCount	integer	The number of entries per page.	30
TotalRecordCount	integer	The total number of entries.	2
Items	array<object>	The list of result items.
	object
Status	string	The task status. Valid values: RUNNING: The task is running. FAILED: The task failed and was interrupted.	RUNNING
FinishTime	string	The end time of the task, in the yyyy-MM-dd'T'HH:mm:ss'Z' format.	2021-10-20T20:00:00Z
Progress	string	The task progress, in percentage (%).	80
BeginTime	string	The start time of the task, in the yyyy-MM-dd'T'HH:mm:ss'Z' format.	2021-10-20T19:40:00Z
TaskErrorCode	string	The error code of the failed task.	TaskErrorCode
DBName	string	The database name associated with the task. This parameter is generally empty.	DBName
ProgressInfo	string	The detailed progress information of the task. This parameter is generally empty.	ProgressInfo
ScaleOutToken	string	The scale-out ID if the task is a scale-out task. This is a unique key in the backend.	FEA5DC20-6D8A-5979-97AA-FC57546ADC20
TaskId	string	The task ID.	20089398
TaskErrorMessage	string	The error message of the failed task.	TaskErrorMessage
TaskAction	string	The task action, which is the unique key for the backend task type.	multi_scale_out

Examples

Success response

JSON format

{
  "RequestId": "D6045D78-C119-5A17-9DEA-0F810394E008",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "RUNNING",
      "FinishTime": "2021-10-20T20:00:00Z",
      "Progress": "80",
      "BeginTime": "2021-10-20T19:40:00Z",
      "TaskErrorCode": "TaskErrorCode",
      "DBName": "DBName",
      "ProgressInfo": "ProgressInfo",
      "ScaleOutToken": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
      "TaskId": "20089398",
      "TaskErrorMessage": "TaskErrorMessage",
      "TaskAction": "multi_scale_out"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.