DescribeBackups - 查看备份集列表 -

查询云数据库 Tair（兼容 Redis）实例的备份文件信息。

接口说明

本接口不适用云原生版集群架构实例，如有需要请使用 DescribeClusterBackupList 接口。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeBackups	get	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	r-bp1zxszhcgatnx****
BackupId	long	否	备份文件的 ID。	11611111
BackupJobId	long	否	备份任务 ID，由 CreateBackup 返回，CreateBackup 若返回多个 BackupJobId，则需要使用本接口分别对其查询。	10001
PageSize	integer	否	每页最大记录数，取值：30、50、100、200 或 300。	30
PageNumber	integer	否	页码，取值大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
StartTime	string	是	查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2019-03-11T10:00Z
EndTime	string	是	查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。	2019-03-14T18:00Z
NeedAof	string	否	是否开启 AoF 落盘，取值： 0：关闭。 1：开启。说明默认值：0。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	963C20F0-7CE1-4591-AAF3-6F3CD1CE****
PageNumber	integer	页码。	1
PageSize	integer	每页最大记录数。	30
TotalCount	integer	备份总个数。	5
FullStorageSize	long	当前实例全量备份文件的大小，单位是字节。全量备份来源于每天定时备份、手动备份、缓存分析时生成的备份等。说明该值和当前请求所响应的备份集数量以及大小无关，而是该实例当前所有有效全量备份的大小。	1000
LogStorageSize	long	当前实例日志备份文件的大小，单位是字节，当且仅当开启闪回时才有效。说明该值和当前请求所响应的备份集数量以及大小无关，而是该实例当前所有有效日志备份的大小。	5000
FreeSize	long	该参数未生效，请忽略该参数。	100000
Backups	array<object>	备份集详情。
Backup	object	备份集详情。
BackupStatus	string	备份状态，返回值： Success：成功。 Failed：失败。	Success
BackupStartTime	string	备份开始时间。	2019-03-14T05:28:50Z
BackupType	string	备份类型，返回值： FullBackup：全量备份。 IncrementalBackup：增量备份。	FullBackup
BackupDownloadURL	string	备份文件的外网下载地址。	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
NodeInstanceId	string	节点 ID。说明当实例的架构为标准版时，本参数返回的是实例 ID。	r-bp10noxlhcoim2****-db-1
BackupEndTime	string	备份结束时间。	2019-03-14T05:31:13Z
BackupId	long	备份文件 ID。	165*****50
BackupDBNames	string	备份的数据库，默认为 all，即备份所有数据库。	all
EngineVersion	string	引擎版本，即实例兼容 Redis 的版本。	4.0
BackupIntranetDownloadURL	string	备份文件的内网下载地址。说明您可以在与该实例连通的 ECS（二者需属于同一 VPC 内）上使用该地址下载目标备份文件。	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSize	long	备份文件大小。	1024
BackupMode	string	备份模式，返回值： Automated：自动备份。 Manual：手动备份。	Automated
BackupMethod	string	备份方法，返回值： Logical：逻辑备份。 Physical：物理备份。	Physical
BackupJobID	long	备份任务 ID。	24340
RecoverConfigMode	string	备份集中是否包含了账号（account）、内核参数（whitelist）、白名单（config）信息。说明本参数仅适用于云原生版实例。若您修改实例的上述信息（例如新建了一个账号或添加了一个白名单），在后续的备份集中会自动备份上述信息。	{"whitelist":true,"config":true,"account":true}
AccessDeniedDetail	object	本组参数已弃用，请忽略。
AuthAction	string	说明如上。	-
AuthPrincipalDisplayName	string	说明如上。	-
AuthPrincipalOwnerId	string	说明如上。	-
AuthPrincipalType	string	说明如上。	-
EncodedDiagnosticMessage	string	说明如上。	-
NoPermissionType	string	说明如上。	-
PolicyType	string	说明如上。	-

示例

正常返回示例

JSON格式

{
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.	-
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.	结束时间验证失败，时间格式应该为gmt时间例如2011-06-11T16:00Z
400	InvalidEngineVersion.Malformed	The Specified EngieVersion is not valid.	-
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time.	结束时间必须大于开始时间
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	-

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

变更历史

变更时间	变更内容概要	操作
2024-09-06	OpenAPI 错误码发生变更	查看变更详情
2024-05-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-06	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-03-26	OpenAPI 错误码发生变更	查看变更详情
2024-01-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-03	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-11-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-06	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-11-29	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情