DescribeBackupSetDownloadTaskList - Database Backup - Alibaba Cloud Documentation Center

Queries backup set download tasks.

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:DescribeBackupSetDownloadTaskList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule. Note You must set one of the BackupPlanId and BackupSetDownloadTaskId parameters.	dbsqhnuhyw3****
BackupSetDownloadTaskId	string	No	The ID of the backup set download task. Full backup set download task: You can call the CreateFullBackupSetDownload operation to create a full backup set download task and obtain the ID of the task. Incremental backup set download task: You can call the CreateIncrementBackupSetDownload operation to create an incremental backup set download task and obtain the ID of the task.	urxgrxt7****
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Note Default value: 30.	30
PageNum	integer	No	The number of the page to return. The value must be a positive integer. Default value: 0.	1
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzXXXXXX

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number of the returned page.	0
RequestId	string	The ID of the request.	6DC3D286-E0E6-5988-A558-2184984B****
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of returned pages.	1
TotalElements	integer	The total number of backup set download tasks.	1
PageSize	integer	The number of entries returned on each page.	30
Items	array<object>	The details of the backup schedules.
BackupSetDownloadTaskDetail	object	The details of the backup schedule.
BackupSetDownloadStatus	string	The status of the backup set download task. Valid values: checking: The backup set download task is being prechecked. init: The backup set download task is not started and fails to pass the precheck. check_pass: The backup set download task passes the precheck. pause: The backup set download task is paused. schedule: The backup set download task is waiting to be scheduled running: The backup set download task is running. stop: The backup set download task fails. finish: The backup set download task is complete.	finish
BackupSetDataSize	long	The size of the data in the backup set.	237837
BackupSetDownloadTargetType	string	The type of the destination server to which the backup set is downloaded. Note This parameter is available only if the value of the BackupSetDownloadWay parameter is auto. A value of agent indicates a server on which a backup gateway is installed.	N/A
BackupSetDownloadDir	string	The server directory to which the backup set is downloaded. Note This parameter is available only if the value of the BackupSetDownloadWay parameter is auto.	N/A
ErrMessage	string	The error message.	java.lang.IndexOutOfBoundsException.
BackupSetDownloadCreateTime	long	The timestamp that indicates when the backup set download task was created.	1642044001000
BackupPlanId	string	The ID of the backup schedule.	qhnuhyw3****
BackupSetDbType	string	The type of the database.	MySQL
BackupSetDownloadInternetUrl	string	The public download URL of the backup set. Note This parameter is available only if the value of the BackupSetDownloadWay parameter is manual and the conversion is complete.	"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
BackupSetId	string	The ID of the backup set.	1h7za2yws****
BackupSetDownloadIntranetUrl	string	The internal download URL of the backup set. Note This parameter is available only if the value of the BackupSetDownloadWay parameter is manual and the conversion is complete.	"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
BackupGatewayId	long	The backup gateway that is used to download the backup set. This parameter is available only if the value of the BackupSetDownloadWay parameter is auto.	N/A
BackupSetDownloadWay	string	The method in which the backup set is downloaded. Valid values: manual: The backup set is manually downloaded. auto: The backup set is automatically downloaded.	manual
BackupSetDownloadFinishTime	long	The timestamp that indicates when the backup set download task is complete.	1642044013000
BackupSetJobType	string	The type of the backup set task. Valid values: cbs_backup_sub_full: logical full backup set download task cbs_backup_sub_cont: logical incremental backup set download task	cbs_backup_sub_cont
BackupSetDownloadTaskId	string	The ID of the backup set download task.	urxgrxt7****
BackupSetDownloadTaskName	string	The name of the backup set download task.	1h7za2yws****-ManualCont
BackupSetDataFormat	string	The format in which the backup set is downloaded. Valid values: Native SQL CSV JSON	Native
BackupSetCode	string	The code of the backup set.	mysql-bin.00XXXX

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "6DC3D286-E0E6-5988-A558-2184984B****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "BackupSetDownloadTaskDetail": [
      {
        "BackupSetDownloadStatus": "finish",
        "BackupSetDataSize": 237837,
        "BackupSetDownloadTargetType": "N/A\n",
        "BackupSetDownloadDir": "N/A\n",
        "ErrMessage": "java.lang.IndexOutOfBoundsException.",
        "BackupSetDownloadCreateTime": 1642044001000,
        "BackupPlanId": "qhnuhyw3****",
        "BackupSetDbType": "MySQL",
        "BackupSetDownloadInternetUrl": "\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\"",
        "BackupSetId": "1h7za2yws****",
        "BackupSetDownloadIntranetUrl": "\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\"",
        "BackupGatewayId": 0,
        "BackupSetDownloadWay": "manual",
        "BackupSetDownloadFinishTime": 1642044013000,
        "BackupSetJobType": "cbs_backup_sub_cont",
        "BackupSetDownloadTaskId": "urxgrxt7****",
        "BackupSetDownloadTaskName": "1h7za2yws****-ManualCont",
        "BackupSetDataFormat": "Native",
        "BackupSetCode": "mysql-bin.00XXXX"
      }
    ]
  }
}

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

No change history