查询Redis实例的备份文件信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:DescribeBackups | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例ID。 | r-bp1zxszhcgatnx**** |
BackupId | integer | 否 | 备份文件的ID。 | 11611111 |
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 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 5,
"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
}
]
},
"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. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-11-13 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-11-06 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-07-25 | OpenAPI 描述信息更新,OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-11-29 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|