全部产品
Search

搜索本产品

    云原生数据库 PolarDB：DescribeBackupSet - DescribeBackupSet

    文档中心

    云原生数据库 PolarDB：DescribeBackupSet - DescribeBackupSet

    更新时间：Sep 10, 2026

    调用DescribeBackupSet接口查看备份集详情。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    polardbx:DescribeBackupSet

    none

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    DBInstanceName

    string

    是

    PolarDB-X 实例名称。

    pxc-htri0ori2r****
    BackupSetId

    string

    是

    备份集 ID。

    111
    RegionId

    string

    否

    地域 ID。

    cn-hangzhou
    DestCrossRegion

    string

    否

    跨地域备份的目标地域。

    cn-shanghai

    返回参数

    名称

    类型

    描述

    示例值

    object

    Message

    string

    错误信息。

    successs
    RequestId

    string

    请求 ID。

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

    boolean

    请求是否成功。

    true
    Data

    array<object>

    数据列表。

    array<object>

    EndTime

    integer

    备份结束时间。

    1650251308000
    Status

    integer

    备份集状态：

    • 0： 备份中；

    • 1：备份成功；

    • 2：备份失败。

    1
    BackupSetSize

    integer

    备份集大小， 单位为 byte。

    88803195
    BackupSetId

    integer

    备份集 ID。

    111
    BackupType

    integer

    备份类型：

    • 0：快速备份；

    • 1：一致性备份。

    1
    BeginTime

    integer

    备份开始时间。

    1650250861754
    BackupModel

    integer

    备份模式：

    • 0：自动备份；

    • 1：手动备份。

    0
    OSSList

    array<object>

    备份集 OSS 信息列表。

    object

    BackupSetFile

    string

    OSS 文件名。

    hins3084_data_20220418110623_qp.xb
    LinkExpiredTime

    string

    OSS 文件链接过期时间。

    2022-04-20T08:01:37Z

    示例

    正常返回示例

    JSON格式

    {
  "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"
        }
      ]
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。