Queries the unfinished tasks of PolarDB-X 1.0 instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDrdsInstanceLevelTasks

The operation that you want to perform. Set the value to DescribeDrdsInstanceLevelTasks.

DrdsInstanceId String Yes drdssen12****

The ID of the PolarDB-X 1.0 instance of which the unfinished tasks you want to query.

Response parameters

Parameter Type Example Description
Success Boolean true

Indicates whether the request is successful.

RequestId String 2F7F8080-9132-4279-85D0-B7E5C4305162

The ID of the request.

Tasks Array of Task

The list of returned unfinished tasks.

Task
TaskType Integer 11

The type of the task.

TaskPhase String 1

The phase of the task.

Progress Integer 99

The progress of the task. Valid values: 0 to 100.

AllowCancel Boolean false

Indicates whether the task can be canceled.

TaskStatus Integer 0
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.
ShowProgress Boolean true

Indicates whether the progress of the task is displayed.

TaskName String upgrade_instance

The name of the task.

ProgressDescription String Executing

The description of the task progress.

GmtCreate Long 1568705520000

The timestamp when the task is created.

TargetId Long 12312

The ID of the task.

ErrMsg String The status of the instance is abnormal.

The error message returned for the task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDrdsInstanceLevelTasks
&DrdsInstanceId=drdssen12****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDrdsInstanceLevelTasksResponse>
    <Success>true</Success>
    <RequestId>2F7F8080-9132-4279-85D0-B7E5C4305162</RequestId>
    <Tasks>
        <TaskType>11</TaskType>
        <TaskPhase>1</TaskPhase>
        <Progress>99</Progress>
        <AllowCancel>false</AllowCancel>
        <TaskStatus>0</TaskStatus>
        <ShowProgress>true</ShowProgress>
        <TaskName>upgrade_instance</TaskName>
        <ProgressDescription>Executing</ProgressDescription>
        <GmtCreate>1568705520000</GmtCreate>
        <TargetId>12312</TargetId>
        <ErrMsg>The status of the instance is abnormal.</ErrMsg>
    </Tasks>
</DescribeDrdsInstanceLevelTasksResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "RequestId" : "2F7F8080-9132-4279-85D0-B7E5C4305162",
  "Tasks" : [ {
    "TaskType" : 11,
    "TaskPhase" : "1",
    "Progress" : 99,
    "AllowCancel" : false,
    "TaskStatus" : 0,
    "ShowProgress" : true,
    "TaskName" : "upgrade_instance",
    "ProgressDescription":"Executing",
    "GmtCreate" : 1568705520000,
    "TargetId" : 12312,
    "ErrMsg" : "The status of the instance is abnormal."
  } ]
}

Error codes

HttpCode Error code Error message Description
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred and the request failed.

For a list of error codes, visit the API Error Center.