DescribeTasks - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeTasks operation to query the tasks that are running on an instance.

Operation description

This operation is phased out.

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:
- The required resource types are displayed in bold characters.
- 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
rds:DescribeTasks	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxxxxxx
StartTime	string	No	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-20T01:00Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2020-11-20T02:00Z
PageSize	integer	No	The number of entries to return per page. Valid values: 30 to 100. Default value: 30.	30
PageNumber	integer	No	The page number. Valid values: any non-zero positive integer. Default value: 1.	1
Status	string	No	The status of the task. This parameter is invalid.	2
TaskAction	string	No	The operation that is used by the task.	CreateInstance

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	A103039D-B1B2-4C57-B989-7D7C0DA95426
PageNumber	integer	The page number of the returned page.	1
PageRecordCount	integer	The number of entries on the current page.	30
TotalRecordCount	integer	The total number of returned entries.	40
Items	array<object>	The details of the task execution.
TaskProgressInfo	object
Status	string	The status of the task.	2
FinishTime	string	The end time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.	2020-11-20T02:00Z
Progress	string	The progress of the task in percentage.	100
StepsInfo	string	The details of the subtasks.	null
BeginTime	string	The start time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC .	2020-11-20T01:00Z
ExpectedFinishTime	string	The estimated end time of the task. Note In most cases, this parameter is empty.	null
TaskErrorCode	string	The error code that is returned when an error occurs. Note This parameter is returned only when an error occurs.	null
CurrentStepName	string	The name of the subtask.	create_instance
ProgressInfo	string	The description of the task progress. Note If no progress description is provided for the task, this parameter is empty.	null
StepProgressInfo	string	The progress of the subtask. For example, a value of `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 an error occurs.	null
TaskAction	string	The operation that is used by the task, such as CreateDBInstance.	CreateDBInstance
Remain	integer	The estimated remaining time of the task. Unit: seconds. Note If the task is not running, this parameter is not returned or the returned value is 0.	60
DBName	string	The name of the database. If the task involves a database, the database name is returned.	DBtest
TaskId	string	The ID of the task.	3472xxxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "A103039D-B1B2-4C57-B989-7D7C0DA95426",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 40,
  "Items": {
    "TaskProgressInfo": [
      {
        "Status": "2",
        "FinishTime": "2020-11-20T02:00Z",
        "Progress": "100",
        "StepsInfo": "null",
        "BeginTime": "2020-11-20T01:00Z",
        "ExpectedFinishTime": "null",
        "TaskErrorCode": "null",
        "CurrentStepName": "create_instance",
        "ProgressInfo": "null",
        "StepProgressInfo": "1/4",
        "TaskErrorMessage": "null",
        "TaskAction": "CreateDBInstance",
        "Remain": 60,
        "DBName": "DBtest",
        "TaskId": "3472xxxxx"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IO.Exception	IO exception, retry later.	An I/O error occurred.
400	InvokeServiceFailed	Invoke service failed, retry later.	A request error occurred. Please try again later.

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

Change history

Change time	Summary of changes	Operation
2024-11-18	API Description Update. The Error code has changed	View Change Details