修改MongoDB实例的备份策略。
接口说明
异地备份只适用于云盘副本集、云盘分片实例。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dds:ModifyBackupPolicy | update | *Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 | dds-bp16cb162771**** |
| PreferredBackupTime | string | 否 | 执行备份的时间，格式为HH:mmZ-HH:mmZ（UTC 时间）。 说明
时间范围限制为 1 小时。
| 03:00Z-04:00Z |
| PreferredBackupPeriod | string | 否 | 备份周期，取值说明：
注意 为了数据安全，请一周至少备份两次 MongoDB 说明
传入多个值，请用英文逗号（,）隔开。
| Monday,Wednesday,Friday,Sunday |
| BackupRetentionPeriod | long | 否 | 全量备份保留天数。 说明
| 30 |
| EnableBackupLog | long | 否 | 是否打开日志备份，取值说明：
| 0 |
| LogBackupRetentionPeriod | long | 否 | 日志备份保留天数，默认为 7 天。 取值范围：7~730。 | 7 |
| SnapshotBackupType | string | 否 | 快照备份类型，取值说明：
| Standard |
| BackupInterval | string | 否 | 高频备份频率，取值说明：
说明
| -1 |
| HighFrequencyBackupRetention | long | 否 | 高频备份保留天数，使用该参数前需要先确认已经传入 BackupInterval 字段。默认保留时长一天。 | 1 |
| BackupRetentionPolicyOnClusterDeletion | integer | 否 | 2 | |
| CrossBackupType | string | 否 | 异地备份操作策略：
说明
异地备份必填
| update |
| SrcRegion | string | 否 | 实例所在地域。 说明
| cn-beijing |
| DestRegion | string | 否 | 备份所在地域。 说明
异地备份必填
| cn-hangzhou |
| CrossRetentionType | string | 否 | 异地备份保留类型。
说明
异地备份必填
| delay |
| CrossRetentionValue | integer | 否 | 异地备份保留时长，可设置 3-1825 天。 说明
| 7 |
| CrossBackupPeriod | string | 否 | 异地备份的保留时间。
说明
异地备份必填
| Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday |
| EnableCrossLogBackup | integer | 否 | 是否开启跨地域日志备份 。 说明
异地备份必填
| 1 |
| CrossLogRetentionType | string | 否 | 异地日志备份保留类型。
说明
异地备份必填
| delay |
| CrossLogRetentionValue | integer | 否 | 异地日志备份保留时长，可设置 3-1825 天，需要小于等于 CrossRetentionValue 的值。 说明
异地备份必填
| 3 |
| InstanceType | string | 否 | 实例类型，取值：
说明
| replicate |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | InvalidPreferredBackupPeriod.Malformed | Specified parameter PreferredBackupPeriod is not valid. |
| 400 | InvalidPreferredBackupTime.Malformed | Specified parameter PreferredBackupTime is not valid. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-02-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |