Call the DescribeBackupSetDownloadTaskList operation to view the list that supports viewing the download of automatic snapshot creation backup sets.


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.


Parameter Type Is it required? Example Description
Action String Yes DescribeBackupSetDownloadTaskList

The parameter specified by the system. Valid values: DescribeBackupSetDownloadTaskList .

BackupPlanId String No dbs1hvb0wxxxxxx

The error message returned because the backup plan has expired.

BackupSetDownloadTaskId String No dbstooi01exxxxx

The error message returned because the backup set download task has failed.

PageSize Integer No 30

The number of records on each page. Valid values:

  • 30 (default)
  • 50
  • 100
PageNum Integer No 1

The page number, which must be greater than or equal to 0 but no more than the maximum value of the last nteger value. default value: 0.

RegionId String No cn-hangzhou

The region has expired. You can call DescribeRegions Query.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

It is used to ensure the idempotence of requests and prevent repeated request submission.

return data

Parameter Type Example Description
ErrCode String Param.NotFound

Error code.

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

Error message.

HttpStatusCode Integer 200

HTTP status code.

Items Array of BackupSetDownloadTaskDetail

The details of the backup schedule.

BackupGatewayId Long 2134324232134

Only the automatic download of backup sets on the back up Gateway instance has a value.

BackupPlanId String dbs1hvb0xxxx

The error message returned because the backup plan has expired.

BackupSetCode String UTF_8

The encoding of the source backup set.

  • Full: same as stackackupcachethappens D
  • Incremental: incremental file name
BackupSetDataFormat String SQL

Backup set download data format:

  • Native
  • SQL
  • CSV
  • JSON
BackupSetDataSize Long 213

The data size of the backup set.

BackupSetDbType String MySQL

The type of the database.

BackupSetDownloadCreateTime Long 1554560477000

The timestamp when the bucket was created. set the value to 1554560477000.

BackupSetDownloadDir String test

The Directory of the backup set download server. only automatic downloads have a value.

BackupSetDownloadFinishTime Long 1554560477000

The completion timestamp. valid value: 1554560477000.

BackupSetDownloadInternetUrl String 176.x.x.x

The public download address of the backup set. only data types that are manually downloaded and converted have a value.

BackupSetDownloadIntranetUrl String 176.x.x.x

The internal network download address of the backup set. only manual download types and converted values are available.

BackupSetDownloadStatus String init

The download status of the backup set. Valid values:

  • checking : pre-checking
  • init : indicates a PreCheck failure (not started).
  • check_pass : passes the PreCheck.
  • pause : Suspend
  • schedule : Waiting for scheduling
  • running : Running
  • stop : Failed
  • finish : Complete
BackupSetDownloadTargetType String agent

The type of the destination to which backup sets are downloaded. only automatic download is displayed.

  • Agent: The backup gateway.
BackupSetDownloadTaskId String dbstooxxxxx

The error message returned because the backup set download task has failed.

BackupSetDownloadTaskName String test

The name of the backup set download task.

BackupSetDownloadWay String auto

Download type:

  • manual : Handmade
  • auto : Automatic
BackupSetId String dbsxxxxxx

The error message returned because the source backup set has expired.

BackupSetJobType String cbs_backup_sub_full

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

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

The exception information.

PageNum Integer 1

page number.

PageSize Integer 30

The number of records on each page.

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

The error message returned because the request already exists.

Success Boolean true

indicates whether the operation was successful.

TotalElements Integer 1

The total number of backup set download records.

TotalPages Integer 1

The total number of pages returned.


Sample requests

     http(s):// operationality=DescribeBackupSetDownloadTaskList&examackupwanlantedd=dbs1hvb0wxxxxx &<common request parameters> 

Sample success responses

XML Format

     <DescribeBackupSetDownloadTaskListResponse> <RequestId>BFE78B4D-7D57-43D8-ABCA-D11DED1F768E</RequestId> <PageSize>30</PageSize> <PageNum>0</PageNum> <HttpStatusCode>200</HttpStatusCode> <TotalElements>0</TotalElements> <TotalPages>0</TotalPages> <Items></Items> <Success>true</Success> </DescribeBackupSetDownloadTaskListResponse> 

JSON Format

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

Error code

Access error Center For more information, see error codes.