调用ModifyInstanceCrossBackupPolicy接口修改RDS跨地域备份设置。
接口说明
仅适用于如下实例类型：
- RDS MySQL：支持的实例版本请参见MySQL跨地域备份。
- RDS SQL Server：支持的实例版本请参见SQL Server跨地域备份。
- RDS PostgreSQL ：支持的实例版本请参见PostgreSQL跨地域备份。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:ModifyInstanceCrossBackupPolicy | WRITE |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。 | rm-uf6wjk5xxxxxxxxxx |
| RegionId | string | 是 | 源实例地域ID，可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
| CrossBackupType | string | 否 | 跨地域备份保存类型。当前唯一取值：1，表示每个备份都保存。 | 1 |
| LogBackupEnabled | string | 否 | 跨地域日志备份开关，取值：
说明跨地域备份总开关开启时，才能设置日志开关。 | 1 |
| BackupEnabled | string | 否 | 跨地域备份总开关（数据备份+日志备份），取值：
说明开启跨地域备份时，必须传入目的地域ID。 | 1 |
| CrossBackupRegion | string | 否 | 跨地域备份的目的地域ID。 | cn-shanghai |
| RetentType | integer | 否 | 跨地域备份保留方式。当前唯一取值：1，表示按时长保留。 | 1 |
| Retention | integer | 否 | 跨地域备份保留天数，取值：7~1825。 | 7 |
返回参数
示例
正常返回示例
JSON格式
{
"BackupEnabled": "Enable",
"RegionId": "cn-hangzhou",
"LogBackupEnabled": "Enable",
"RequestId": "50A6059D-6DBB-46C6-A851-1EE93C9013CF",
"RetentType": 1,
"CrossBackupRegion": "cn-shanghai",
"CrossBackupType": "1",
"Retention": 15,
"DBInstanceId": "rm-uf6wjk5xxxxxxxxxx"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameters.Format | Specified parameter is not valid. | - |
| 400 | ParameterAbsence | Necessary param is absence. | - |
| 400 | ParameterLeastAssociate | Must input at least one optional parameter. | 还原时间或备份集不能同时为空，请设置后重试。 |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定的地域不合法，请检查该参数的正确性。 |
| 400 | InvalidParameters.Format | Specified parameter(maxrecordsperpage) is not valid. | - |
| 400 | OperationDenied.SwitchToCrossRegionBackup | Snapshot backup does not support cross region backup storage at present. | 操作失败，快照备份目前不支持跨区域备份存储。 |
| 400 | OperationDenied.SwitchToSnapshot | Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode. | 操作失败，快照备份目前不支持跨区域存储。在切换到快照备份模式之前，请关闭跨区域备份。 |
| 400 | OperationDenied.SwitchSnapshotToPhysical | Only physical backup to snapshot backup is supported. | 当前操作仅支持物理备份到快照备份。 |
| 400 | UnsupportEncryptedSnapshot | Encrypted DB instance snapshot does not support this operation. | 加密的实例快照不支持此操作。 |
| 403 | IncorrectEngineVersion | Current engine version does not support operations. | 操作失败，当前数据库版本不支持此操作。 |
| 403 | IncorrectHostType | Current DB Instance host type does not support this operation. | 当前DB实例主机类型不支持此操作。 |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败，该实例状态下不支持此操作。 |
| 403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失败，数据库引擎不支持。 |
| 403 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败，实例处于锁定状态。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 实例状态非运行中 |
| 403 | InvalidDdrStorage.NotFound | Specified Ddr Storage does not exist or not support. | - |
| 403 | CrossBackupNotSupport | Specified region not support cross region backup. | 指定的区域不支持跨区域备份。 |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
| 404 | InvalidPage.notFound | Page not found. | 指定参数未找到，请检查确认参数。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2022-09-01 | OpenAPI 错误码发生变更 | |||||||||
| ||||||||||
| 2022-06-23 | OpenAPI 错误码发生变更 | |||||||||
|