该接口用于查看RDS实例的备份集列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeBackups | READ |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
| BackupId | string | 否 | 备份集ID。 | 327329803 |
| BackupStatus | string | 否 | 备份集状态。取值：
| Success |
| BackupMode | string | 否 | 备份模式，取值：
| Automated |
| StartTime | string | 否 | 查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。 | 2011-06-01T16:00Z |
| EndTime | string | 否 | 查询结束时间，需要大于查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。 说明
建议您在使用本接口查询备份集列表信息时，将查询开始和结束的时间段缩小一些，如果时间段较长可能出现超时问题。
| 2011-06-15T16:00Z |
| PageSize | integer | 否 | 每页记录数，取值：
默认值：30。 | 30 |
| PageNumber | integer | 否 | 页码，取值：大于0且不超过Integer的最大值。 默认值：1。 | 1 |
| BackupType | string | 否 | 备份类型，取值：
| FullBackup |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmy**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
"TotalEcsSnapshotSize": 0,
"PageRecordCount": "30",
"TotalRecordCount": "100",
"PageNumber": "1",
"Items": {
"Backup": [
{
"StorageClass": "0",
"Encryption": "{}",
"BackupStatus": "Success",
"StoreStatus": "Disabled",
"ConsistentTime": 1576506856,
"BackupType": "FullBackup",
"CopyOnlyBackup": "0",
"BackupEndTime": "2019-02-13T12:20:00Z",
"MetaStatus": "OK",
"BackupInitiator": "System",
"BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
"BackupMethod": "Physical",
"BackupStartTime": "2019-02-03T12:20:00Z",
"BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
"IsAvail": 1,
"BackupId": "321020562",
"HostInstanceID": "5882781",
"BackupSize": 2167808,
"BackupMode": "Automated",
"DBInstanceId": "rm-uf6wjk5****",
"Checksum": "1835830439****",
"BackupDownloadLinkByDB": {
"BackupDownloadLinkByDB": [
{
"IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1",
"DataBase": "dbs",
"DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1"
}
]
},
"ResourceGroupId": "rg-acfmy****"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidRestoreTime.Malformed | The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup. | 请求的restoreTime参数无效，或者请求的resstoreTime不在实例备份的范围内。 |
| 400 | InvalidPageNumbers.Malformed | Specified page number is not valid. | 页码数不存在。 |
| 400 | InvalidStartTime.Format | Specified start time is not valid. | 指定的起始时间无效。 |
| 400 | InvalidEndTime.Format | Specified end time is not valid. | 您提交的结束时间无效，请重新提交正确信息 |
| 400 | InvalidParameterCombination | The end time must be greater than the start time | 结束时间必须晚于开始时间。 |
| 400 | InvalidDBinstanceClass.ValueNotSupported | The specified parameter DBinstanceClass is invalid. | 指定的参数“实例规格”无效 |
| 400 | InvalidBackupSetLocation.Format | Specified backup set location is not valid. | 指定的备份集位置无效。 |
| 403 | InvalidMaxRecordsPerPage.Malformed | Specified record number is not valid. | 指定的记录号不正确。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例，请检查实例的正确性。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2021-10-21 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|
