DocsICP FilingConsole
Documentation

DescribeBackupSetDownloadTaskList

Updated at:
Copy as MD
Product
My Favorites

Queries the download list of DBS backup sets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DescribeBackupSetDownloadTaskList

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
BackupPlanId

string

No

The ID of the backup plan. You can call the DescribeBackupPlanList operation to query the value of this parameter.

Note

You must specify either BackupPlanId or BackupSetDownloadTaskId as a required request parameter.

dbsqhnuhyw3****
BackupSetDownloadTaskId

string

No

The ID of the backup set download task.

urxgrxt7****
PageSize

integer

No

The number of entries per page. Valid values: 30, 50, and 100.

Note

Default value: 30.

30
PageNum

integer

No

The page number. The value must be greater than or equal to 0 and cannot exceed the maximum value of an integer. Default value: 0.

1
ClientToken

string

No

The client token used to ensure the idempotence of the request and prevent duplicate submissions. You can enter any value.

ETnLKlblzczshOTUbOCzXXXXXX

Response elements

Element

Type

Description

Example

object

The details of the response parameters.

HttpStatusCode

integer

The HTTP status code.

200
PageNum

integer

The page number.

0
RequestId

string

The request ID.

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 pages.

1
TotalElements

integer

The total number of backup set download records.

1
PageSize

integer

The number of entries per page.

30
Items

object

BackupSetDownloadTaskDetail

array<object>

The details of the backup plan.

object

The details of the backup plan.

BackupSetDownloadStatus

string

The download status of the backup set. Valid values:

  • checking: prechecking

  • init: precheck failed (not started)

  • check_pass: precheck passed

  • pause: paused

  • schedule: waiting for scheduling

  • running: running

  • stop: failed

  • finish: completed

finish
BackupSetDataSize

integer

The data size of the backup set.

237837
BackupSetDownloadTargetType

string

The target type for downloading the backup set.

Note

This parameter is displayed only for automatic downloads. A value of agent indicates that a backup gateway is installed.

None
BackupSetDownloadDir

string

The server directory for downloading the backup set.

Note

This parameter has a value only for automatic downloads.

None
ErrMessage

string

The exception message.

java.lang.IndexOutOfBoundsException.
BackupSetDownloadCreateTime

integer

The creation timestamp.

1642044001000
BackupPlanId

string

The ID of the backup plan.

qhnuhyw3****
BackupSetDbType

string

The database type.

MySQL
BackupSetDownloadInternetUrl

string

The public download URL of the backup set.

Note

This parameter has a value only for manual downloads that have completed conversion.

"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
BackupSetId

string

The ID of the source backup set.

1h7za2yws****
BackupSetDownloadIntranetUrl

string

The internal download URL of the backup set.

Note

This parameter has a value only for manual downloads that have completed conversion.

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

integer

The backup gateway of the backup set. This parameter has a value only for automatic downloads.

None
BackupSetDownloadWay

string

The download type. Valid values:

  • manual: manual

  • auto: automatic

manual
BackupSetDownloadFinishTime

integer

The completion timestamp.

1642044013000
BackupSetJobType

string

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

  • cbs_backup_sub_full: logical full backup task

  • cbs_backup_sub_cont: logical incremental backup 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 data format of the downloaded backup set. Valid values:

  • Native

  • SQL

  • CSV

  • JSON

Native
BackupSetCode

string

The code of the source backup set.

mysql-bin.00XXXX

Examples

Success response

JSON format

{
  "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": "无",
        "BackupSetDownloadDir": "无",
        "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

Description
403 Request.Forbidden Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.