DescribeBackupDataList - 查询备份数据 - 数据库备份 DBS

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

接口说明

适用引擎

PolarDB MySQL 版

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dbs:DescribeBackupDataList	list	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceName	string	否	PolarDB 实例 ID。	pc-2ze3nrr64c5******
RegionCode	string	否	备份集所在地域。	cn-hangzhou
SceneType	string	否	备份场景类型，当前仅支持LEVEL_1，即实例所在地域的一级备份。	LEVEL_1
StartTime	string	否	查询开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-04-17T17:00:16Z
EndTime	string	否	查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-04-17T17:00:32Z
BackupStatus	string	否	备份集状态，取值如下： OK：备份成功 ERROR：备份失败	OK
BackupId	string	否	备份集 ID。	213064****
BackupMethod	string	否	备份方式，取值如下： Physical：物理备份 Logical：逻辑备份 Snapshot：快照备份	Snapshot
BackupMode	string	否	备份模式，取值如下： Automated：系统自动备份 Manual：手动备份	Automated
BackupType	string	否	备份类型，取值如下： FullBackup：全量备份 IncrementBackup：增量备份	FullBackup
BackupScale	string	否	备份规格，取值如下： DBInstance：实例备份 DBTable：库表备份	DBInstance
PageSize	integer	否	每页记录数，默认值为 20。	20
PageNumber	integer	否	页码，取值范围为大于 0 但不超过 Integer 最大值的整数，默认值为 1。	1
InstanceIsDeleted	boolean	否	实例是否已删除，取值如下： true：已删除 false：未删除（默认值）	false
InstanceRegion	string	否	原实例所在地域。	cn-hangzhou
DataSourceId	string	否	预留参数，暂无需关注。	test****

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
Data	object	返回数据如下。
Content	array<object>	任务详情。
Content	object	任务详情。
BackupId	string	备份集 ID。	213088****
BackupName	string	备份集名称。	logic_backup
BackupMode	string	备份模式，返回值如下： Automated：系统自动备份 Manual：手动备份	Automated
BackupType	string	备份类型，返回值如下： FullBackup：全量备份 IncrementBackup：增量备份	FullBackup
BackupScale	string	备份规格，返回值如下： DBInstance：实例备份 DBTable：库表备份	DBInstance
BackupMethod	string	备份方式，返回值如下： Physical：物理备份 Logical：逻辑备份 Snapshot：快照备份	Snapshot
BackupSize	long	备份集大小，单位 Byte。	25669140480
BackupStatus	string	备份集状态，返回值如下： OK：备份成功 ERROR：备份失败	OK
BackupStartTime	string	备份开始时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-04-17T17:00:16Z
BackupEndTime	string	备份结束时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-04-17T17:00:32Z
ConsistentTime	long	一致性快照的时间点，格式为 Unix 时间戳，单位为秒（s）。	1713373221
BackupLocation	string	备份存储路径。	logic
InstanceName	string	实例 ID。	pc-2ze3nrr64c5******
Engine	string	引擎类型。	polardb_mysql
EngineVersion	string	引擎版本。	5.7
SupportDeletion	integer	备份集是否支持删除，返回值如下： 0：支持 1：不支持	0
Encryption	string	加密信息。	psk2
IsAvail	integer	备份集是否可用，返回值如下： 1：可用 0：不可用	1
Checksum	string	校验码。	84a4c16431f969712e6895992719****
BackupDownloadURL	string	备份集公网下载地址。说明仅当 BackupMethod 为 Physical（物理备份）或 Logical（逻辑备份）时，返回该参数。	http://oss.com/****
BackupIntranetDownloadURL	string	备份集内网下载地址。说明仅当 BackupMethod 为 Physical（物理备份）或 Logical（逻辑备份）时，返回该参数。	http://oss.com/****
ExpectExpireType	string	备份集预期过期类型，返回值如下： NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	备份集预期过期时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-04-19T05:00:49Z
PolarSnapshot	object	PolarDB 二级转储信息。说明仅当 PolarDB 实例开启同地域二级转储功能，并且一级备份转储成功后，才会返回 PolarSnapshot 相关信息。
DumpId	long	转储 ID。	abc****
DumpSize	long	转储备份大小，单位为 Byte。	25669140589
expectExpireType	string	备份集预期过期类型，返回值如下： NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	备份集预期过期时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-04-19T05:00:49Z
PageSize	long	分页大小。	20
PageNumber	long	分页页码。	1
TotalPages	long	分页总页数。	1
TotalElements	long	备份集总个数。	1
Extra	string	额外信息。	dbtest
RequestId	string	请求 ID。	95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCode	string	错误码。	Request.Forbidden
Success	string	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
Code	string	状态码。	Success
Message	string	返回信息。	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	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

数据库备份 DBS：DescribeBackupDataList - 查询备份数据

接口说明

适用引擎

相关功能文档

调试

授权信息

请求参数

返回参数

示例

错误码