DescribeBackups_云数据库 Tair（兼容 Redis®）_API文档

2015-01-01

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为200/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

kvstore:DescribeBackups	Get	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	无	无

请求参数

字段名称	字段详情
InstanceIdstring	实例 ID。示例值:r-bp1zxszhcgatnx****参考取值来源: CreateInstance ModifyInstanceSSL RestartInstance RestoreInstance DescribeInstances
BackupIdinteger<int64>	备份文件的 ID。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:11611111
BackupJobIdinteger<int64>	备份任务 ID，由 CreateBackup 返回，CreateBackup 若返回多个 BackupJobId，则需要使用本接口分别对其查询。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10001参考取值来源: CreateBackup DescribeBackupTasks
PageSizeinteger<int32>	每页最大记录数，取值：30、50、100、200 或 300。示例值:30枚举值:30501002003001000
PageNumberinteger<int32>	页码，取值大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。示例值:1
StartTimestring	查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。示例值:2019-03-11T10:00Z
EndTimestring	查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。示例值:2019-03-14T18:00Z
NeedAofstring	是否开启 AoF 落盘，取值：展开详情示例值:1

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:963C20F0-7CE1-4591-AAF3-6F3CD1CE****
PageNumberinteger<int32>	页码。示例值:1
PageSizeinteger<int32>	每页最大记录数。示例值:30
TotalCountinteger<int32>	备份总个数。示例值:5
FullStorageSizeinteger<int64>	当前实例全量备份文件的大小，单位是字节。全量备份来源于每天定时备份、手动备份、缓存分析时生成的备份等。展开详情注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1000
LogStorageSizeinteger<int64>	当前实例日志备份文件的大小，单位是字节，当且仅当开启闪回时才有效。展开详情注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:5000
FreeSizeinteger<int64>	该实例的免费备份额度，单位是字节，免费额度为实例规格默认内存量，更多信息请参见备份商业化通知。展开详情注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:100000
Backupsobject
AccessDeniedDetailobject	本组参数已弃用，请忽略。

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.	诊断
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.	诊断
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	变更请求参数PageSize
	2024-05-23	变更返回参数
	2024-05-06	变更返回参数
	2024-03-26	变更请求参数BackupId 变更请求参数BackupJobId
	2024-01-22	变更返回参数
	2024-01-03	新增请求参数BackupJobId
	2023-11-13	变更返回参数
	2023-11-06	变更返回参数
	2023-07-25	变更返回参数
	2022-11-29	变更返回参数

相关示例

查询Redis实例的审计日志和备份信息

2021-01-30