文档

ModifyInstanceCrossBackupPolicy - 修改RDS跨地域备份设置

更新时间:

该接口用于修改RDS跨地域备份设置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ModifyInstanceCrossBackupPolicyWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
  • rds:BackupEnabled
  • rds:LogBackupEnabled

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

rm-uf6wjk5****
RegionIdstring

源实例地域 ID,可以通过接口 DescribeRegions 查看地域 ID。

cn-hangzhou
CrossBackupTypestring

跨地域备份保存类型。当前唯一取值:1,表示每个备份都保存。

1
LogBackupEnabledstring

跨地域日志备份开关,取值:

  • 0:关闭
  • 1:开启
说明 跨地域备份总开关开启时,才能设置日志开关。
1
BackupEnabledstring

跨地域备份总开关(数据备份+日志备份),取值:

  • 0:关闭
  • 1:开启
说明 开启跨地域备份时,必须传入目的地域 ID。
1
CrossBackupRegionstring

跨地域备份的目的地域 ID。

cn-shanghai
RetentTypeinteger

跨地域备份保留方式。当前唯一取值:1,表示按时长保留。

1
Retentioninteger

跨地域备份保留天数,取值:7~1825

7

返回参数

名称类型描述示例值
object

返回参数详情。

BackupEnabledstring

跨地域备份总开关,取值:

  • Disable:关闭
  • Enable:开启
Enable
RegionIdstring

源实例地域 ID,可以通过接口 DescribeRegions 查看地域 ID。

cn-hangzhou
LogBackupEnabledstring

跨地域日志备份开关,取值:

  • Disable:关闭
  • Enable:开启
Enable
RequestIdstring

请求 ID。

50A6059D-6DBB-46C6-A851-1EE93C9013CF
RetentTypeinteger

跨地域备份保留方式。默认值:1,表示按时长保留。

1
CrossBackupRegionstring

跨地域备份的目的地域 ID。

cn-shanghai
CrossBackupTypestring

跨地域备份保存类型。默认值:1,表示每个备份都保存。

1
Retentioninteger

跨地域备份保留天数,取值:7~1825

15
DBInstanceIdstring

实例 ID。

rm-uf6wjk5****

示例

正常返回示例

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-uf6wjk5****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameters.FormatSpecified parameter is not valid.-
400ParameterAbsenceNecessary param is absence.-
400ParameterLeastAssociateMust input at least one optional parameter.还原时间或备份集不能同时为空,请设置后重试。
400InvalidRegion.FormatSpecified Region is not valid.指定的地域不合法,请检查该参数的正确性。
400InvalidParameters.FormatSpecified parameter(maxrecordsperpage) is not valid.-
400OperationDenied.SwitchToCrossRegionBackupSnapshot backup does not support cross region backup storage at present.操作失败,快照备份目前不支持跨区域备份存储。
400OperationDenied.SwitchToSnapshotSnapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.操作失败,快照备份目前不支持跨区域存储。在切换到快照备份模式之前,请关闭跨区域备份。
400OperationDenied.SwitchSnapshotToPhysicalOnly physical backup to snapshot backup is supported.当前操作仅支持物理备份到快照备份。
400UnsupportEncryptedSnapshotEncrypted DB instance snapshot does not support this operation.加密的实例快照不支持此操作。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
403IncorrectEngineVersionCurrent engine version does not support operations.操作失败,当前数据库版本不支持此操作。
403IncorrectHostTypeCurrent DB Instance host type does not support this operation.当前DB实例主机类型不支持此操作。
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403InvalidDdrStorage.NotFoundSpecified Ddr Storage does not exist or not support.-
403CrossBackupNotSupportSpecified region not support cross region backup.指定的区域不支持跨区域备份。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404InvalidPage.notFoundPage not found.指定参数未找到,请检查确认参数。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
2022-06-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
  • 本页导读 (1)
文档反馈