All Products
Search
Document Center

Database Backup:DescribeBackupSetDownloadTaskList

Last Updated:Mar 03, 2024

Queries backup set download tasks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:DescribeBackupSetDownloadTaskListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringNo

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.
dbsqhnuhyw3****
BackupSetDownloadTaskIdstringNo

The ID of the backup schedule.

urxgrxt7****
PageSizeintegerNo

The code of the backup set.

30
PageNumintegerNo

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

1
ClientTokenstringNo

The name of the backup set download task.

ETnLKlblzczshOTUbOCzXXXXXX

Response parameters

ParameterTypeDescriptionExample
object

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.

HttpStatusCodeinteger

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.
200
PageNuminteger

The timestamp that indicates when the backup set download task is complete.

0
RequestIdstring

The page number of the returned page.

6DC3D286-E0E6-5988-A558-2184984B****
ErrCodestring

The error message.

Param.NotFound
Successboolean

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.
true
ErrMessagestring

The size of the data in the backup set.

The specified parameter %s value is not valid.
TotalPagesinteger

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.
1
TotalElementsinteger

N/A

1
PageSizeinteger

The format in which the backup set is downloaded. Valid values:

  • Native
  • SQL
  • CSV
  • JSON
30
Itemsobject []

The HTTP status code.

BackupSetDownloadStatusstring

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.
finish
BackupSetDataSizelong

N/A

237837
BackupSetDownloadTargetTypestring

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.
The number of entries to return on each page. Valid values: 30, 50, and 100. > Default value: 30.
BackupSetDownloadDirstring

The ID of the backup set.

The total number of returned pages.
ErrMessagestring

ETnLKlblzczshOTUbOCzXXXXXX

java.lang.IndexOutOfBoundsException.
BackupSetDownloadCreateTimelong

N/A

1642044001000
BackupPlanIdstring

The type of the database.

qhnuhyw3****
BackupSetDbTypestring

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.
MySQL
BackupSetDownloadInternetUrlstring

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
"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
BackupSetIdstring

The error code.

1h7za2yws****
BackupSetDownloadIntranetUrlstring

The timestamp that indicates when the backup set download task was created.

"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
BackupGatewayIdlong

The total number of backup set download tasks.

The error message.
BackupSetDownloadWaystring

The number of the page to return. The value must be a positive integer. Default value: 0.

manual
BackupSetDownloadFinishTimelong

The number of entries returned on each page.

1642044013000
BackupSetJobTypestring

The ID of the backup set download task.

cbs_backup_sub_cont
BackupSetDownloadTaskIdstring

The ID of the request.

urxgrxt7****
BackupSetDownloadTaskNamestring

Queries backup set download tasks.

1h7za2yws****-ManualCont

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": "The number of entries to return on each page. Valid values: 30, 50, and 100.\n\n> Default value: 30.\n",
        "BackupSetDownloadDir": "The total number of returned pages.\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

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

Change history

Change timeSummary of changesOperation
No change history