备案控制台
文档
产品文档
输入文档关键字查找
首页 数据库备份 开发参考 API参考（2021-01-01） API目录 其他 DescribeBackupDataList - 查询备份数据

DescribeBackupDataList - 查询备份数据

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

查询PolarDB MySQL版备份数据详情。

接口说明

适用引擎

PolarDB MySQL 版

说明 当前该接口仅针对特定客户开放使用，如有需求，请到 DBS 客户咨询群（钉钉群号：35585947）申请使用。

相关功能文档

PolarDB MySQL 版备份操作

调试

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

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:DescribeBackupDataListList
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    无
无

请求参数

名称类型必填描述示例值
InstanceNamestring否

PolarDB 实例 ID。

pc-2ze3nrr64c5******
RegionCodestring否

备份集所在地域。

cn-hangzhou
SceneTypestring否

备份场景类型，当前仅支持LEVEL_1，即实例所在地域的一级备份。

LEVEL_1
StartTimestring否

查询开始时间，格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。

2024-04-17T17:00:16Z
EndTimestring否

查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。

2024-04-17T17:00:32Z
BackupStatusstring否

备份集状态，取值如下：

  • OK：备份成功
  • ERROR：备份失败
OK
BackupIdstring否

备份集 ID。

213064****
BackupMethodstring否

备份方式，取值如下：

  • Physical：物理备份
  • Logical：逻辑备份
  • Snapshot：快照备份
Snapshot
BackupModestring否

备份模式，取值如下：

  • Automated：系统自动备份
  • Manual：手动备份
Automated
BackupTypestring否

备份类型，取值如下：

  • FullBackup：全量备份
  • IncrementBackup：增量备份
FullBackup
BackupScalestring否

备份规格，取值如下：

  • DBInstance：实例备份
  • DBTable：库表备份
DBInstance
PageSizeinteger否

每页记录数，默认值为 20。

20
PageNumberinteger否

页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。

1
InstanceIsDeletedboolean否

实例是否已删除，取值如下：

  • true：已删除
  • false：未删除（默认值）
false
InstanceRegionstring否

原实例所在地域。

cn-hangzhou
DataSourceIdstring否

预留参数，暂无需关注。

test****

返回参数

名称类型描述示例值
object

返回参数详情。

Dataobject

返回数据如下。

Contentobject []

任务详情。

BackupIdstring

备份集 ID。

213088****
BackupNamestring

备份集名称。

logic_backup
BackupModestring

备份模式，返回值如下：

  • Automated：系统自动备份
  • Manual：手动备份
Automated
BackupTypestring

备份类型，返回值如下：

  • FullBackup：全量备份
  • IncrementBackup：增量备份
FullBackup
BackupScalestring

备份规格，返回值如下：

  • DBInstance：实例备份
  • DBTable：库表备份
DBInstance
BackupMethodstring

备份方式，返回值如下：

  • Physical：物理备份
  • Logical：逻辑备份
  • Snapshot：快照备份
Snapshot
BackupSizelong

备份集大小，单位 Byte。

25669140480
BackupStatusstring

备份集状态，返回值如下：

  • OK：备份成功
  • ERROR：备份失败
OK
BackupStartTimestring

备份开始时间，格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。

2024-04-17T17:00:16Z
BackupEndTimestring

备份结束时间，格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。

2024-04-17T17:00:32Z
ConsistentTimelong

一致性快照的时间点，格式为 Unix 时间戳，单位为秒（s）。

1713373221
BackupLocationstring

备份存储路径。

logic
InstanceNamestring

实例 ID。

pc-2ze3nrr64c5******
Enginestring

引擎类型。

polardb_mysql
EngineVersionstring

引擎版本。

5.7
SupportDeletioninteger

备份集是否支持删除，返回值如下：

  • 0：支持
  • 1：不支持
0
Encryptionstring

加密信息。

psk2
IsAvailinteger

备份集是否可用，返回值如下：

  • 1：可用
  • 0：不可用
1
Checksumstring

校验码。

84a4c16431f969712e6895992719****
BackupDownloadURLstring

备份集公网下载地址。

说明 仅当 BackupMethod 为 Physical（物理备份）或 Logical（逻辑备份）时，返回该参数。
http://oss.com/****
BackupIntranetDownloadURLstring

备份集内网下载地址。

说明 仅当 BackupMethod 为 Physical（物理备份）或 Logical（逻辑备份）时，返回该参数。
http://oss.com/****
ExpectExpireTypestring

备份集预期过期类型，返回值如下：

  • NEVER
  • EXPIRED
  • DELAY
DELAY
ExpectExpireTimestring

备份集预期过期时间，格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。

2024-04-19T05:00:49Z
PolarSnapshotobject

PolarDB 二级转储信息。

说明 仅当 PolarDB 实例开启同地域二级转储功能，并且一级备份转储成功后，才会返回 PolarSnapshot 相关信息。
DumpIdlong

转储 ID。

abc****
DumpSizelong

转储备份大小，单位为 Byte。

25669140589
expectExpireTypestring

备份集预期过期类型，返回值如下：

  • NEVER
  • EXPIRED
  • DELAY
DELAY
ExpectExpireTimestring

备份集预期过期时间，格式：yyyy-MM-ddTHH:mmZ（UTC 时间）。

2024-04-19T05:00:49Z
PageSizelong

分页大小。

20
PageNumberlong

分页页码。

1
TotalPageslong

分页总页数。

1
TotalElementslong

备份集总个数。

1
Extrastring

额外信息。

dbtest
RequestIdstring

请求 ID。

95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCodestring

错误码。

Request.Forbidden
Successstring

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败
true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
Codestring

状态码。

Success
Messagestring

返回信息。

The specified parameter %s value is not valid.

示例

正常返回示例

JSON格式

{
  "Data": {
    "Content": [
      {
        "BackupId": "213088****",
        "BackupName": "logic_backup",
        "BackupMode": "Automated",
        "BackupType": "FullBackup",
        "BackupScale": "DBInstance",
        "BackupMethod": "Snapshot",
        "BackupSize": 25669140480,
        "BackupStatus": "OK",
        "BackupStartTime": "2024-04-17T17:00:16Z",
        "BackupEndTime": "2024-04-17T17:00:32Z",
        "ConsistentTime": 1713373221,
        "BackupLocation": "logic",
        "InstanceName": "pc-2ze3nrr64c5******",
        "Engine": "polardb_mysql",
        "EngineVersion": "5.7",
        "SupportDeletion": 0,
        "Encryption": "psk2",
        "IsAvail": 1,
        "Checksum": "84a4c16431f969712e6895992719****",
        "BackupDownloadURL": "http://oss.com/****",
        "BackupIntranetDownloadURL": "http://oss.com/****",
        "ExpectExpireType": "DELAY",
        "ExpectExpireTime": "2024-04-19T05:00:49Z",
        "PolarSnapshot": {
          "DumpId": 0,
          "DumpSize": 25669140589,
          "expectExpireType": "DELAY",
          "ExpectExpireTime": "2024-04-19T05:00:49Z"
        }
      }
    ],
    "PageSize": 20,
    "PageNumber": 1,
    "TotalPages": 1,
    "TotalElements": 1,
    "Extra": "dbtest"
  },
  "RequestId": "95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28",
  "ErrCode": "Request.Forbidden\t",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Code": "Success",
  "Message": "The specified parameter %s value is not valid."
}

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

访问错误中心查看更多错误码。
文档推荐
  • 本页导读
文档反馈