You can call this DescribeBackupSetDownloadTaskList to view the DBS backup set download list.


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 Position Type Required Example Description
Action Query String Required DescribeBackupSetDownloadTaskList

The operation that you want to perform. Valid values: DescribeBackupSetDownloadTaskList.

BackupPlanId Query String  No dbs1hvb0wxxxxxx

The ID of the backup plan.

BackupSetDownloadTaskId Query String  No dbstooi01exxxxx

The ID of the backup set download task.

PageSize Query Integer Optional 30

The number of entries returned per page. Valid values:

  • 30
  • 50
  • 100
Note Default value: 30.
PageNum Query Integer Optional 1

The number of the page to return. Valid values: any non-zero positive Integer. Default value: 0.

RegionId Host String  No cn-hangzhou

The region ID of the instance. You can call DescribeRegions query.

ClientToken Query String  No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotence of the request.

Response parameters

Parameter Type Example Description
ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

Items Array of BackupSetDownloadTaskDetail

The details of the backup plan.

BackupGatewayId Long 2134324232134

The backup set backs up the Gateway and automatically downloads only available values.

BackupPlanId String dbs1hvb0xxxx

The ID of the backup plan.

BackupSetCode String UTF_8

The ID of the source backup set.

  • All: the same as BackupSetId
  • Incremental: incremental file name
BackupSetDataFormat String SQL

Download the backup set data format:

  • Native
  • SQL
  • CSV
  • JSON
BackupSetDataSize Long 213

The size of backup set data.

BackupSetDbType String MySQL

The database engine that the instance runs.

BackupSetDownloadCreateTime Long 1554560477000

The creation timestamp. Value: 1554560477000.

BackupSetDownloadDir String test

The Directory of the backup set download server. HBR automatically downloads only available backup sets.

BackupSetDownloadFinishTime Long 1554560477000

The completion timestamp. Valid value: 1554560477000.

BackupSetDownloadInternetUrl String 176.x.x.x

The public download URL of the backup set. Only data that is manually downloaded and converted can be used.

BackupSetDownloadIntranetUrl String 176.x.x.x

The internal download URL of the backup set. It only contains the URL that is manually downloaded and converted.

BackupSetDownloadStatus String init

The download status of the backup set. Valid values:

  • init: Initialization
  • warning: Failed
  • Caught: abnormal.
  • running
  • failed: The check task returned negative results.
  • finish
BackupSetDownloadTargetType String agent

The type of the destination for downloading Backup sets. Only backup sets with values are downloaded automatically.

Note agent: The backup gateway is installed.
BackupSetDownloadTaskId String dbstooxxxxx

The ID of the backup set download task.

BackupSetDownloadTaskName String test

The name of the backup set download task.

BackupSetDownloadWay String auto

Download type:

  • manual
  • auto
BackupSetId String dbsxxxxxx

The ID of the source backup set.

BackupSetJobType String cbs_backup_sub_full

The task type of the source backup set. Valid values:

  • Logical full task: cbs_backup_sub_full
  • Logical incremental task: cbs_backup_sub_cont
ErrMessage String java.lang.IndexOutOfBoundsException.

The error message.

PageNum Integer 1

The page number of the page to be returned.

PageSize Integer 30

The number of records per page.

RequestId String BFE78B4D-7D57-43D8-ABCA-D11DED1F768E

The request ID.

Success Boolean true

Indicates whether the request succeeded.

TotalElements Integer 1

The total number of backup set download records.

TotalPages Integer 1

The total number of returned pages.


Sample requests

http(s):// Action=DescribeBackupSetDownloadTaskList
&BackupPlanId = dbs1hvb0wxxxxx
&<Common request parameters>

Sample success responses

XML format


JSON format

    "RequestId": "BFE78B4D-7D57-43D8-ABCA-D11DED1F768E",
    "PageSize": 30,
    "PageNum": 0,
    "HttpStatusCode": 200,
    "TotalElements": 0,
    "TotalPages": 0,
    "Items": "",
    "Success": true

Error codes

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