DescribeDrdsInstanceLevelTasks - PolarDB - Alibaba Cloud Documentation Center

Queries incomplete tasks in a DRDS instance by calling the DescribeDrdsInstanceLevelTasks operation.

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

drds:DescribeDrdsInstanceLevelTasks

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drdssen12****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	2F7F8080-9132-4279-85D0-B7E5C4305162
Tasks	object
Task	array<object>	The list of incomplete tasks.
	object
TaskType	integer	The type of the task.	11
TaskPhase	string	The phase of the task.	1
Progress	integer	The progress of the task. Valid values: 0 to 100.	99
AllowCancel	boolean	Indicates whether the task can be canceled.	false
TaskStatus	integer	The state of the task. Valid values: 0: The task is being executed. 1: The task is executed. 2: The task failed to be executed. 3: The task is canceled.	0
ShowProgress	boolean	Indicates whether the progress of the task is displayed.	true
TaskName	string	The name of the task.	upgrade_instance
ProgressDescription	string	The description of the task progress.	正在执行
GmtCreate	integer	The timestamp when the task is created.	1568705520000
TargetId	integer	The ID of the task.	12312
ErrMsg	string	The error message returned for the task.	实例状态异常

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "2F7F8080-9132-4279-85D0-B7E5C4305162",
  "Tasks": {
    "Task": [
      {
        "TaskType": 11,
        "TaskPhase": "1",
        "Progress": 99,
        "AllowCancel": false,
        "TaskStatus": 0,
        "ShowProgress": true,
        "TaskName": "upgrade_instance",
        "ProgressDescription": "正在执行",
        "GmtCreate": 1568705520000,
        "TargetId": 12312,
        "ErrMsg": "实例状态异常"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.