All Products
Search

This Product

    PolarDB:DescribeBackupSet

    Document Center

    PolarDB:DescribeBackupSet

    Last Updated:Sep 10, 2026

    Queries the details of a backup set by calling the DescribeBackupSet operation.

    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

    polardbx:DescribeBackupSet

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceName

    string

    Yes

    The name of the PolarDB-X instance.

    pxc-htri0ori2r****
    BackupSetId

    string

    Yes

    The backup set ID.

    111
    RegionId

    string

    No

    The region ID.

    cn-hangzhou
    DestCrossRegion

    string

    No

    The destination region for cross-region backup.

    cn-shanghai

    Response elements

    Element

    Type

    Description

    Example

    object

    Message

    string

    The error message.

    successs
    RequestId

    string

    The request ID.

    1A6D328C-84B8-40DC-BF49-6C73984D7494
    Success

    boolean

    Indicates whether the request was successful.

    true
    Data

    array<object>

    The data list.

    array<object>

    EndTime

    integer

    The backup end time.

    1650251308000
    Status

    integer

    The status of the backup set. Valid values:

    • 0: Backing up.

    • 1: Backup succeeded.

    • 2: Backup failed.

    1
    BackupSetSize

    integer

    The size of the backup set, in bytes.

    88803195
    BackupSetId

    integer

    The backup set ID.

    111
    BackupType

    integer

    The backup type. Valid values:

    • 0: Fast backup.

    • 1: Consistent backup.

    1
    BeginTime

    integer

    The backup start time.

    1650250861754
    BackupModel

    integer

    The backup mode. Valid values:

    • 0: Automatic backup.

    • 1: Manual backup.

    0
    OSSList

    array<object>

    The list of OSS information for the backup set.

    object

    BackupSetFile

    string

    The OSS file name.

    hins3084_data_20220418110623_qp.xb
    LinkExpiredTime

    string

    The expiration time of the OSS file link.

    2022-04-20T08:01:37Z

    Examples

    Success response

    JSON format

    {
  "Message": "successs",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "Success": true,
  "Data": [
    {
      "EndTime": 1650251308000,
      "Status": 1,
      "BackupSetSize": 88803195,
      "BackupSetId": 111,
      "BackupType": 1,
      "BeginTime": 1650250861754,
      "BackupModel": 0,
      "OSSList": [
        {
          "BackupSetFile": "hins3084_data_20220418110623_qp.xb",
          "LinkExpiredTime": "2022-04-20T08:01:37Z",
          "IntranetDownloadLink": "http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?",
          "DownloadLink": "https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy"
        }
      ]
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.