详情页标题前

阿里云RDS数据库ModifyBackupPolicy – 修改实例备份策略-云淘科技

• 阿里云数据库
详情页1

该接口用于修改RDS实例的备份策略设置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

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

  • RDS MySQL自动备份策略设置
  • RDS PostgreSQL自动备份策略设置
  • RDS SQL Server自动备份策略设置
  • RDS MariaDB自动备份策略设置

调试

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

调试阿里云RDS数据库ModifyBackupPolicy - 修改实例备份策略-云淘科技调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
DBInstanceId string 是

实例ID。可调用DescribeDBInstances获取。

 rm-uf6wjk5****
BackupPolicyMode string 否

备份类型：

  • DataBackupPolicy：数据备份
  • LogBackupPolicy：日志备份
 DataBackupPolicy
PreferredBackupTime string 否

执行备份任务的时间。格式：HH:mmZ-HH:mmZ（UTC时间）。

说明

  • BackupPolicyMode为DataBackupPolicy时，该参数必传。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  00:00Z-01:00Z
    PreferredBackupPeriod string 否

    备份周期。至少需要指定2天，多个取值用英文逗号（,）隔开。取值：

    • Monday：周一
    • Tuesday：周二
    • Wednesday：周三
    • Thursday：周四
    • Friday：周五
    • Saturday：周六
    • Sunday：周日

    说明

  • 与BackupInterval参数共同决定备份策略。例如：本参数指定周六周日备份，BackupInterval参数指定30分钟，则在每周的周六和周日每隔30分钟执行一次备份。
  • BackupPolicyMode参数为DataBackupPolicy时，该参数必传。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  Monday
    BackupRetentionPeriod string 否

    数据备份保留天数，取值：7~730。

    说明

  • BackupPolicyMode为DataBackupPolicy时，该参数必传。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  7
    BackupLog string 否

    是否开启日志备份。取值：

    • Enable：开启。
    • Disabled：关闭。

    说明

  • BackupPolicyMode为DataBackupPolicy时，用于开启或关闭日志备份。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  Enable
    LogBackupRetentionPeriod string 否

    日志备份保留天数。取值：7~730，且不大于数据备份保留天数。

    说明

  • 当开启日志备份时，可设置日志备份文件的保留天数，目前仅支持MySQL和PostgreSQL实例设置该值。
  • BackupPolicyMode参数为DataBackupPolicy或LogBackupPolicy时都适用。
    		•  7
    EnableBackupLog string 否

    是否开启日志备份。取值：

    • True或1：开启。
    • False或0：关闭。

    说明

  • BackupPolicyMode为LogBackupPolicy时，用于开启或关闭日志备份。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
    		•  1
    LocalLogRetentionHours string 否

    日志备份本地保留小时数。取值：0~7*24，0表示不保留。

    说明

  • BackupPolicyMode为LogBackupPolicy时，该参数必传。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
    		•  18
    LocalLogRetentionSpace string 否

    本地日志最大循环空间使用率，超出后，则从最早的Binlog开始清理，直到空间使用率低于该比例。取值：0~50。默认不修改。

    说明

  • BackupPolicyMode为LogBackupPolicy时，该参数必传。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
    		•  30
    HighSpaceUsageProtection string 否

    实例使用空间大于80%，或者剩余空间小于5GB时，是否无条件清理Binlog。取值：Enable | Disable。默认不修改。

    说明

  • BackupPolicyMode为LogBackupPolicy时，该参数必传。
  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
    		•  Enable
    LogBackupFrequency string 否

    日志备份频率，取值：

    • LogInterval：每30分钟备份一次。
    • 默认与数据备份频率一致。

    说明

  • LogInterval参数仅适用于SQL Server。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  LogInterval
    CompressType string 否

    备份压缩方式。取值：

    • 0：不压缩。
    • 1：zlib压缩，格式为tar.gz。
    • 2：并行zlib压缩。
    • 4：quicklz压缩，格式为xb.gz。仅适用于MySQL 5.6/5.7，此备份压缩方式可用于单库单表恢复。
    • 8：quicklz压缩，格式为xb.gz。仅适用于MySQL 8.0。暂不支持单库单表恢复。

    说明
    仅在BackupPolicyMode参数为DataBackupPolicy时生效。

    		4
    ArchiveBackupRetentionPeriodstring否

    归档备份的保留天数。默认为0，表示未开启归档备份。取值：30~1095。

    说明
    仅在BackupPolicyMode参数为DataBackupPolicy时生效。

    		365
    ArchiveBackupKeepPolicystring否

    归档备份的保留周期，该周期内能保存的备份个数由ArchiveBackupKeepCount决定。默认为0。取值：

    • ByMonth：月
    • ByWeek：周
    • KeepAll：全部保留

    说明
    仅在BackupPolicyMode参数为DataBackupPolicy时生效。

    		ByMonth
    ArchiveBackupKeepCountinteger否

    归档备份的保留个数。默认为1。取值：

    • 当ArchiveBackupKeepPolicy为ByMonth时，取值为1~31。
    • 当ArchiveBackupKeepPolicy为ByWeek时，取值为1~7。

    说明

  • 当ArchiveBackupKeepPolicy为KeepAll时，本参数无需传入。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  1
    ReleasedKeepPolicy string 否

    已删除实例的归档备份保留策略。默认为None。取值：

    • None：不保留
    • Lastest：保留最后一个
    • All：全部保留

    说明
    仅在BackupPolicyMode参数为DataBackupPolicy时生效。

    		None
    LogBackupLocalRetentionNumberinteger否

    本地Binlog保留个数。默认为60。取值：6~100。

    说明

  • 仅在BackupPolicyMode参数为LogBackupPolicy时生效。
  • 如果实例类型为MySQL，可以传入**-1**，即不限制本地Binlog的保留个数。
    		•  60
    Category string 否

    是否开启秒级备份。取值：

    • Flash：开启
    • Standard：关闭

    说明
    仅在BackupPolicyMode参数为DataBackupPolicy时生效。

    		Standard
    BackupIntervalstring否

    快照备份频率。取值：

    • -1：不设置备份频率。
    • 30：30分钟。
    • 60：60分钟。
    • 120：120分钟。
    • 240：240分钟。
    • 480：480分钟。

    说明

  • 与PreferredBackupPeriod参数共同决定备份策略。例如：PreferredBackupPeriod参数指定周六周日备份，本参数指定**-1**，则在每周的周六和周日各执行一次备份。
  • PostgreSQL实例必须是云盘实例。
  • SQL Server实例必须已开启快照备份。
  • Category参数为Flash时本参数无效。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  30
    BackupMethod string 否

    实例的备份方式。取值：

    • Physical：物理备份
    • Snapshot：快照备份

    默认值：Physical

    说明

  • 本参数仅对SQL Server云盘版实例生效。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  Physical
    EnableIncrementDataBackup boolean 否

    是否开启增量备份。取值：

    • False（默认）：关闭
    • True：开启

    说明

  • 本参数仅对SQL Server云盘版实例生效。
  • 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
    		•  False
    BackupPriority integer 否

    设置备库备份选项。取值：

    • 1：优先备库
    • 2：强制主库

    说明

  • 该参数仅适用于SQL Server集群版实例。
  • 仅当BackupMethod取值为Physical时，该参数才生效。如果BackupMethod设置为Snapshot，SQL Server集群版实例将强制在主库备份。
    		•  2

    返回参数

    名称 类型 描述 示例值
    object

    返回参数详情。
    RequestId string

    请求ID。

    		 DA147739-AEAD-4417-9089-65E9B1D8240D
    CompressType string

    备份压缩方式，取值：

    • 0：不压缩。
    • 1：zlib压缩。
    • 2：并行zlib压缩。
    • 4：quicklz压缩，开启了库表恢复。
    • 8：MySQL8.0 quicklz压缩但是还未支持库表恢复。
    		 4
    LocalLogRetentionSpace string

    本地日志最大循环空间使用率。

    		 30
    LogBackupLocalRetentionNumber integer

    本地Binlog保留个数。

    		 60
    DBInstanceID string

    实例ID。

    		 rm-uf6wjk5****
    EnableBackupLog string

    是否开启了日志备份。取值：

    • 1：开启
    • 0：关闭
    		 1
    LocalLogRetentionHours integer

    日志备份本地保留小时数。

    		 18
    HighSpaceUsageProtection string

    实例使用空间大于80%，或者剩余空间小于5GB时，是否无条件清理Binlog。

    		 Disable

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D",
  "CompressType": "4",
  "LocalLogRetentionSpace": "30",
  "LogBackupLocalRetentionNumber": 60,
  "DBInstanceID": "rm-uf6wjk5****",
  "EnableBackupLog": "1",
  "LocalLogRetentionHours": 18,
  "HighSpaceUsageProtection": "Disable"
}

    错误码

    HTTP status code 错误码 错误信息 描述
    400 InvalidColdRetention.Format Invalid cold retention format. –
    400 InvalidLogBackupFrequency.Malformed Invalid log backup frequency. 日志备份频率（LogBackupFrequency）无效，请检查参数是否正确。
    400 InvalidBackupRetentionPeriod.Malformed The specified backup retention period is invalid. 备份周期不能为空。请设置备份周期，备份周期不能小于1天或大于30天。
    400 BackupPropertyNotFound Backup policy not found 操作失败，无法找到备份策略。
    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 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. –
    403 IncorrectCategory Current Instance type does not support Category. 当前实例类型不支持类别。
    403 OperationDenied.SwitchSnapshotToPhysical Only physical backup to snapshot backup is supported. 当前操作仅支持物理备份到快照备份。
    403 OperationDenied.ModifyBackupSwitchOff The switch is not turned on. It is forbidden to modify the backup mode. 切换失败，未开启跨地域备份。
    403 OperationDenied.ApiForbiddenForLogBackupFrequency When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup. 当实例为快照备份时，日志备份频率不允许为”与数据备份一致”。
    403 OperationDenied.NotSupportedBackupMethod When the storage is larger than 4000 GB, only snapshot backup is supported. 当存储空间大于4000GB，仅支持快照备份。
    403 OperationDenied.ApiForbidden Operation is not permitted. 操作不允许

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

    变更历史

    变更时间 变更内容概要 操作
    2023-06-29 OpenAPI 错误码发生变更，OpenAPI 入参发生变更 看变更集
    变更项 变更内容
    错误码 OpenAPI 错误码发生变更
      删除错误码：400
      删除错误码：403
    入参 OpenAPI 入参发生变更
      新增入参：BackupPriority
    2022-05-10 OpenAPI 错误码发生变更 看变更集
    变更项 变更内容
    错误码 OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码：403

    内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家

    阿里云企业补贴进行中： 马上申请

    腾讯云限时活动1折起，即将结束： 马上收藏

    同尘科技为腾讯云授权服务中心。

    购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠

    转转请注明出处：http://www.yunxiaoer.com/154713.html

    赞 (0)
    0
    上一篇 2023年12月9日 下午7:11
    下一篇 2023年12月9日
    详情页2

    相关推荐

    • 阿里云负载均衡DeleteAccessLogsDownloadAttribute – 删除访问日志下载任务-云淘科技

      删除指定传统型负载均衡实例的访问日志。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。 调试调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：…

      阿里云负载均衡 2023年12月10日

    • 阿里云ECS云服务器DescribeDemands-云淘科技

      调用DescribeDemands查询报备资源的交付及使用状态。 接口说明 您可通过该接口查询阿里云为您报备的资源详情，包括报备资源类型、资源的交付情况以及资源的消费情况。 默认查询I/O优化实例规格，以及专有网络VPC类型的ECS实例的报备表单状态。 如果您需要获取关于创建ECS资源需求报备信息（CreateDemand）、修改ECS资源需求报备信息（Mo…

      阿里云服务器 2023年12月9日

    • 阿里云ECS云服务器删除实例启动模板和版本-云淘科技

      如果您不再需要某些实例启动模板和版本，可以对其进行删除。本文介绍如何删除实例启动模板和指定的版本。 重要 如果删除实例启动模板，该模板下的所有版本都将被删除，请慎重操作。 删除实例启动模板 通过控制台删除 登录ECS管理控制台。 在左侧导航栏，选择部署与弹性 > > 实例启动模板。 在页面左侧顶部，选择目标资源所在的地域。 在启动模板列表页面，删…

      阿里云服务器 2023年12月9日

    • 阿里云云原生大数据计算服务 MaxComputePyODPS API概述-云淘科技

      本文为您提供了PyODPS API文档链接，其中包含各函数的参数说明及示例。 ODPS详解（Definitions） PyODPS DataFrame指南（DataFrame Reference） 内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家阿里云企业补贴进行中： 马上申请腾讯云限时活动1折起，即将结束： 马上收藏同尘科技为腾讯云授权服务中心…

      阿里云大数据计算服务MaxCompute 2023年12月10日
    • 信息流广告，信息流部分建议宽度830px，只针对默认列表样式，顺序随机

    • 阿里云ECS云服务器配置ECS实例的IPv6地址-云淘科技

      默认情况下，您在新建ECS实例时只分配IPv4地址，不分配IPv6地址。如需使用IPv6地址并通过IPv6地址访问公网时，您需要配置IPv6地址。本文介绍如何配置ECS实例的IPv6地址。 前提条件 为新建实例分配IPv6地址时，需确保实例所在的VPC和交换机已经开通IPv6网段。更多信息，请参见VPC开启IPv6和交换机开启IPv6。 为已有实例分配IPv…

      阿里云服务器 2023年12月9日

    联系我们

    400-800-8888

    在线咨询： QQ交谈

    邮件：admin@example.com

    工作时间：周一至周五，9:30-18:30，节假日休息

    关注微信
    本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买，续费优惠，保证底价，买贵退差。