全部产品
Search
文档中心

云数据库 MongoDB:ModifyBackupPolicy - 修改实例的备份策略

更新时间:Mar 15, 2024

修改MongoDB实例的备份策略。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

dds-bp16cb162771****
PreferredBackupTimestring

执行备份的时间,格式为HH:mmZ-HH:mmZ(UTC 时间)。

说明 时间范围限制为 1 小时。
03:00Z-04:00Z
PreferredBackupPeriodstring

备份周期,取值说明:

  • Monday:周一。
  • Tuesday:周二。
  • Wednesday:周三。
  • Thursday:周四。
  • Friday:周五。
  • Saturday:周六。
  • Sunday:周日。
说明 如需传入多个值,请用英文逗号(,)隔开。
Monday,Wednesday,Friday,Sunday
BackupRetentionPeriodlong

全量备份保留天数。

说明
  • 2021 年 09 月 10 日前用户默认保留天数为 7 天。
  • 2021 年 09 月 10 日后新用户默认保留天数为 30 天。
  • 30
    EnableBackupLoglong

    是否打开日志备份,取值说明:

    • 0:关闭(默认值)。
    • 1:打开。
    0
    LogBackupRetentionPeriodlong

    日志备份保留天数,默认为 7 天。

    取值范围:7~730。

    7
    SnapshotBackupTypestring

    快照备份类型,取值说明:

    • Flash:秒级备份。
    • Standard:常规备份(默认值)。
    Standard
    BackupIntervalstring

    高频备份频率,取值说明:

    • -1:不开启高频备份。
    • 30:每 30 分钟。
    • 60:每 1 小时。
    • 120:每 2 小时。
    • 180:每 3 小时。
    • 240:每 4 小时。
    • 360:每 6 小时。
    • 480:每 8 小时。
    • 720:每 12 小时。
    说明
  • SnapshotBackupType 取值为 Standard 时,该参数取值固定为**-1**。
  • SnapshotBackupType 取值为 Flash,且该参数取值大于 0 时,高频备份才生效。
  • -1
    HighFrequencyBackupRetentionlong

    高频备份保留天数,使用该参数前需要先确认已经传入 BackupInterval 字段。默认保留时长一天。

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    644A359C-B871-4DD3-97B5-ED91EF5809C2

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
    }

    错误码

    HTTP status code错误码错误信息
    400InvalidPreferredBackupPeriod.MalformedSpecified parameter PreferredBackupPeriod is not valid.
    400InvalidPreferredBackupTime.MalformedSpecified parameter PreferredBackupTime is not valid.

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

    变更历史

    变更时间变更内容概要操作
    2024-02-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:HighFrequencyBackupRetention