DescribeTasks - PolarDB - Alibaba Cloud Documentation Center

Queries the status of the tasks that are generated based on API operations, such as the status of instance creation tasks.

Operation description

You can call this operation to view the details of a task that is generated by a specific API operation or in the PolarDB console. The system calls the specific API operation when you perform an operation in the PolarDB console. For example, you can view the details of the task when you call the CreateDBCluster operation or create a cluster in the PolarDB console.
You can view the details of tasks that are generated only when you call the CreateDBCluster operation to create a cluster and CreationOption is not set to CreateGdnStandby.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeTasks	get	*dbcluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	No	The cluster ID. Note You must specify `DBNodeId` or `DBClusterId`. You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.	pc-***************
DBNodeId	string	No	The node ID. Note You must specify `DBNodeId` or `DBClusterId`. You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as node IDs.	pi-***************
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.	2020-11-30T00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC. The end time must be later than the start time.	2020-12-02T03:00Z
Status	string	No	The state of the tasks that you want to query. Valid values: Waiting: The task is pending. Running: The task is running. Finished: The task is completed. Closed: The task is closed. Pause: The task is paused. Stop: The task is interrupted. Note If you do not specify this parameter, the operation returns the details of only the tasks that are in the Waiting or Running state for the cluster or node. You can enter multiple task states. Separate multiple task states with commas (,).	Running
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalRecordCount	integer	The total number of entries returned.	1
PageRecordCount	integer	The number of entries returned per page.	30
Tasks	array<object>	The details of the task.
Task	object
FinishTime	string	The time when the task was completed. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.	2020-12-02T02:40:15Z
StepsInfo	string	The details of the subtasks.	[{\"remain\":0,\"name\":\"init_task\",\"progress\":100},{\"remain\":1764,\"name\":\"create_instance\",\"progress\":0},{\"remain\":1,\"name\":\"init_cluster\",\"progress\":0},{\"remain\":2,\"name\":\"create_backup\",\"progress\":0}]
Progress	integer	The progress of the task in percentage.	100
ExpectedFinishTime	string	The estimated end time of the task. In most cases, this parameter is empty.	null
BeginTime	string	The time when the task was started. The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format. The time is displayed in UTC.	2020-12-02T02:39:15Z
TaskErrorCode	string	The error code that is returned when an error occurs. Note This parameter is returned only when the task is in the Stop state.	null
ProgressInfo	string	The description of the task progress. If no progress description is provided for the task, this parameter is empty.	null
CurrentStepName	string	The name of the current step.	create_instance
StepProgressInfo	string	The progress of the subtasks. For example, the value `1/4` indicates that the task consists of four subtasks and the first subtask is in progress.	1/4
TaskErrorMessage	string	The error message that is returned when an error occurs. Note This parameter is returned only when the task is in the Stop state.	null
TaskAction	string	The API operation that is used by the task. Example: `CreateDBInstance`.	CreateDBInstance
DBName	string	The database name. Note This parameter is returned for only the tasks that involve database operations.	test
Remain	integer	The estimated remaining duration of the task. Unit: seconds.	1767
TaskId	string	The ID of the task.	111111111
EndTime	string	The end time of the query.	2020-12-02T03:00Z
RequestId	string	The request ID.	4352AD99-9FF5-41A6-A319-068089******
PageNumber	integer	The page number of the page returned.	1
StartTime	string	The start time of the query.	2020-11-30T00:00Z
DBClusterId	string	The ID of the cluster for which the task was created.	pc-***************

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "Tasks": {
    "Task": [
      {
        "FinishTime": "2020-12-02T02:40:15Z",
        "StepsInfo": "[{\\\"remain\\\":0,\\\"name\\\":\\\"init_task\\\",\\\"progress\\\":100},{\\\"remain\\\":1764,\\\"name\\\":\\\"create_instance\\\",\\\"progress\\\":0},{\\\"remain\\\":1,\\\"name\\\":\\\"init_cluster\\\",\\\"progress\\\":0},{\\\"remain\\\":2,\\\"name\\\":\\\"create_backup\\\",\\\"progress\\\":0}]",
        "Progress": 100,
        "ExpectedFinishTime": "null",
        "BeginTime": "2020-12-02T02:39:15Z",
        "TaskErrorCode": "null",
        "ProgressInfo": "null",
        "CurrentStepName": "create_instance",
        "StepProgressInfo": "1/4",
        "TaskErrorMessage": "null",
        "TaskAction": "CreateDBInstance",
        "DBName": "test",
        "Remain": 1767,
        "TaskId": "111111111"
      }
    ]
  },
  "EndTime": "2020-12-02T03:00Z",
  "RequestId": "4352AD99-9FF5-41A6-A319-068089******",
  "PageNumber": 1,
  "StartTime": "2020-11-30T00:00Z",
  "DBClusterId": "pc-***************"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The specified EndTime parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
400	InvalidStatus.Malformed	The specified parameter Status is not valid.	The specified Status parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details