All Products
Search

This Product

    Data Management:DescribeBackupSetDownloadTaskList

    Document Center

    Data Management:DescribeBackupSetDownloadTaskList

    Last Updated:Jan 13, 2026

    Queries the list of download tasks for backup sets in Database Backup Service (DBS).

    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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    No

    The ID of the backup plan. Call the DescribeBackupPlanList operation to obtain the value of this parameter.

    Note

    You must specify either BackupPlanId or BackupSetDownloadTaskId.

    dbsqhnuhyw3****
    BackupSetDownloadTaskId

    string

    No

    The ID of the backup set download task.

    urxgrxt7****
    PageSize

    integer

    No

    The number of entries to return on each page. Valid values: 30, 50, and 100.

    Note

    The default value is 30.

    30
    PageNum

    integer

    No

    The page number. The value must be a non-negative integer that does not exceed the maximum value of the integer type. The default value is 0.

    1
    ClientToken

    string

    No

    A client token that is used to ensure the idempotence of the request. This prevents duplicate requests.

    ETnLKlblzczshOTUbOCzXXXXXX

    Response elements

    Element

    Type

    Description

    Example

    object

    The details of the returned 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 was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    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 download records for backup sets.

    1
    PageSize

    integer

    The number of entries returned per page.

    30
    Items

    object

    BackupSetDownloadTaskDetail

    array<object>

    The details of the backup set download task.

    object

    The details of the backup set download task.

    BackupSetDownloadStatus

    string

    The status of the backup set download. Valid values:

    • checking: The task is being prechecked.

    • init: The precheck failed and the task is not started.

    • check_pass: The precheck is passed.

    • pause: The task is paused.

    • schedule: The task is waiting to be scheduled.

    • running: The task is running.

    • stop: The task failed.

    • finish: The task is complete.

    finish
    BackupSetDataSize

    integer

    The size of the backup set data.

    237837
    BackupSetDownloadTargetType

    string

    The target type for the backup set download.

    Note

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

    无
    BackupSetDownloadDir

    string

    The directory on the server to which the backup set is downloaded.

    Note

    This parameter has a value only for automatic downloads.

    无
    ErrMessage

    string

    The error message.

    java.lang.IndexOutOfBoundsException.
    BackupSetDownloadCreateTime

    integer

    The UNIX timestamp that indicates when the task was created.

    1642044001000
    BackupPlanId

    string

    The ID of the backup plan.

    qhnuhyw3****
    BackupSetDbType

    string

    The database type.

    MySQL
    BackupSetDownloadInternetUrl

    string

    The public network download URL for the backup set.

    Note

    This parameter has a value only for manual downloads when the format conversion is complete.

    "//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 for the backup set.

    Note

    This parameter has a value only for manual downloads when the format conversion is complete.

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

    integer

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

    无
    BackupSetDownloadWay

    string

    The download type. Valid values:

    • manual: Manual

    • auto: Automatic

    manual
    BackupSetDownloadFinishTime

    integer

    The UNIX timestamp that indicates when the task was completed.

    1642044013000
    BackupSetJobType

    string

    The type of the source backup set task. 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 encoding 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.