该接口用于查询RDS实例的备份设置。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeBackupPolicy | READ |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
BackupPolicyMode | string | 否 | 备份类型,取值:
| DataBackupPolicy |
CompressType | string | 否 | 备份压缩方式,取值:
| 1 |
ReleasedKeepPolicy | string | 否 | 已删除实例的归档备份保留策略。取值:
| Lastest |
返回参数
示例
正常返回示例
JSON
格式
{
"LogBackupRetentionPeriod": 7,
"ArchiveBackupKeepPolicy": "ByMonth",
"ArchiveBackupKeepCount": "1",
"LocalLogRetentionHours": 0,
"BackupRetentionPeriod": 7,
"RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
"PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
"CompressType": "1",
"SupportReleasedKeep": 0,
"LocalLogRetentionSpace": "30",
"SupportVolumeShadowCopy": 1,
"BackupMethod": "Physical",
"LogBackupFrequency": "LogInterval",
"PreferredNextBackupTime": "2018-01-19T15:15Z",
"HighSpaceUsageProtection": "Enable",
"ArchiveBackupRetentionPeriod": "365",
"BackupInterval": "30",
"ReleasedKeepPolicy": "None",
"PreferredBackupTime": "15:00Z-16:00Z",
"LogBackupLocalRetentionNumber": 60,
"Category": "Standard",
"EnableBackupLog": "1",
"BackupLog": "Enable",
"EnableIncrementDataBackup": true,
"SupportModifyBackupPriority": true,
"BackupPriority": 2
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IO.Exception | IO exception, retry later. | io异常。 |
400 | InternalFailure | Internal failure, retry later. | 请求失败,请稍后重试。 |
400 | InvalidParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 操作失败,参数OwnerAccount不合法,请检查。 |
400 | InvalidEngine.Malformed | Specified engine is not valid. | 当前数据库引擎无效,请选择正确的数据库引擎。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | 数据库实例ID不存在,请检查。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-06-29 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||
| ||||||||||||
2022-06-24 | OpenAPI 描述信息更新,OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|