DescribeDownloadTask - Database Backup

Queries the advanced download tasks for an ApsaraDB RDS for MySQL instance, an ApsaraDB RDS for PostgreSQL instance, or a PolarDB for MySQL cluster.

Operation description

Supported database engines

ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
PolarDB for MySQL

References

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
dbs:DescribeDownloadTask	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionCode	string	Yes	The ID of the region in which the instance resides. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.	cn-hangzhou
InstanceName	string	No	The ID of the instance. Note This parameter is required.	rm-bp1imnmcjxdz7****
DatasourceId	string	No	The ID of the Database Backup (DBS) data source. Specify the parameter in the format of ds-${Instance ID}_${regionId}.	ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetId	string	No	The ID of the backup set generated when you create a download task. You can call the DescribeBackups operation to query the ID.	216****
State	string	No	The state of the download task. Valid values: Initializing: The download task is being initialized. queueing: The download task is queuing. running: The download task is running. failed: The download task fails. finished: The download task is complete. expired: The download task expires.	queueing
TaskType	string	No	The type of the download task. Valid values: full: downloads a full backup set. pitr: downloads a backup set at a specific point in time.	full
StartTime	string	No	The beginning of the time range to query. Specify this parameter as a timestamp of the LONG type. Unit: milliseconds.	1661941554000
EndTime	string	No	The end of the time range to query. Specify this parameter as a timestamp of the LONG type. Unit: milliseconds.	1661941556000
PageSize	string	No	The number of entries to return on each page.	50
CurrentPage	string	No	The page number of the page to return.	1
OrderDirect	string	No	The order in which you want to sort the entries. Valid values: asc: the ascending order. desc: the descending order. This is the default value.	desc
OrderColumn	string	No	The column based on which the entries are sorted. By default, the entries are sorted by the time when the download task was created. Set the value to gmt_create.	gmt_create

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCode	string	The error code returned if the request fails.	DBS.InternalError
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message returned if the request fails.	instanceName can not be empty
Code	string	The error code returned if the request fails.	DBS.InternalError
Message	string	The error message returned if the request fails.	instanceName can not be empty
Data	object	The details of the tasks.
PageNumber	long	The page number of the returned page. The value must be an integer that is greater than 0. Default value: 1.	1
TotalPages	long	The total number of returned pages.	2
Extra	string	The extra description of the download tasks.	dbtest
TotalElements	long	The total number of full backup tasks.	1
PageSize	long	The number of entries returned per page.	10
Content	array<object>	The details of the task.
List	object	The details of the download task.
TaskId	string	The download task ID.	dt-qxntlvgu****
RegionCode	string	The ID of the region in which the instance resides.	cn-hangzhou
Format	string	The format to which the downloaded backup set is converted. Valid values: csv SQL Parquet	csv
DbList	string	The details of the databases.	[dbtest]
BakSetId	string	The ID of the full backup set.	148261****
DownloadStatus	string	The status of the download task. Valid values: Initializing: The download task is being initialized. queuing: The download task is queuing. running: The download task is running. failed: The download task fails. finished: The download task is complete. expired: The download task expires.	queueing
ExportDataSize	string	The amount of output data. Unit: bytes.	0
ImportDataSize	string	The amount of data that is processed. Unit: bytes.	0
BackupSetTime	string	The point in time of the backup set if the task is used to download a backup set at a specific point in time. The value is a timestamp of the LONG type. Unit: millisecond.	1663162216000
TargetType	string	The type of the method in which the backup set is downloaded. Valid values: OSS URL	URL
TargetPath	string	The destination path to which the data is downloaded if the value of TargetType is OSS.	test_db/path
Progress	string	The number of tables that have been downloaded and the total number of tables to be downloaded.	0/0
GmtCreate	string	The time when the download task was created. The value is a timestamp.	1663321957000

Examples

Sample success responses

JSONformat

{
  "RequestId": "5D285EB9-A443-592D-9F3D-A888FAC3****",
  "ErrCode": "DBS.InternalError",
  "Success": "true",
  "ErrMessage": "instanceName can not be empty",
  "Code": "DBS.InternalError",
  "Message": "instanceName can not be empty",
  "Data": {
    "PageNumber": 1,
    "TotalPages": 2,
    "Extra": "dbtest",
    "TotalElements": 1,
    "PageSize": 10,
    "Content": {
      "List": [
        {
          "TaskId": "dt-qxntlvgu****",
          "RegionCode": "cn-hangzhou",
          "Format": "csv",
          "DbList": "[dbtest]",
          "BakSetId": "148261****",
          "DownloadStatus": "queueing",
          "ExportDataSize": "0",
          "ImportDataSize": "0",
          "BackupSetTime": "1663162216000",
          "TargetType": "URL",
          "TargetPath": "test_db/path",
          "Progress": "0/0",
          "GmtCreate": "1663321957000"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message
403	Request.Forbidden	Have no Permissions

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

Change history

Change time	Summary of changes	Operation
2022-11-16	The response structure of the API has changed	View Change Details