云数据库 MongoDB 设置云数据库实例的自动备份规则

1. 接口描述

接口请求域名： mongodb.tencentcloudapi.com 。

本接口（SetBackupRules）用于设置 MongoDB 云数据库的自动备份规则。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SetBackupRules。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-p8vn****
BackupMethod	否	Integer	备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。说明: 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 2. 实例开通存储加密，则备份方式不能为物理备份。示例值：1
BackupTime	否	Integer	设置自动备份开始时间。取值范围为：[0,23]，例如：该参数设置为2，表示02:00开始备份。示例值：2
BackupFrequency	否	Integer	指定每日自动备份频率。 - 12: 每日备份2次，间隔约12小时。 - 24: 每日备份1次（默认），间隔约24小时。示例值：2
Notify	否	Boolean	设置自动备份发生错误时，是否发送失败告警。 - true：发送。 - false：不发送。示例值：true
BackupRetentionPeriod	否	Integer	指定备份数据保留时长。 - 单位：天，默认为 7 天。 - 取值范围：[7,365]。示例值：7
ActiveWeekdays	否	String	指定每周内执行自动备份的具体日期。 - 格式：请输入 0-6 之间的数字代表周日至周六（例如：1 代表周一），多个日期请用英文逗号 , 分隔。 - 示例：输入 1,3,5 表示系统将在每周的周一、周三、周五执行备份。 - 默认值：不设置，则默认为全周期 (0,1,2,3,4,5,6)，即每日执行备份。示例值：0,1,2,3,4,5,6
LongTermUnit	否	String	长期保留周期。支持按周或按月选择特定日期的备份（例如，每月1日、15日的备份数据），将其保留更长周期。 - 不开启（默认）：不启用长期保留功能。 - 按周保留：指定为 weekly。 - 按月保留：指定为 monthly。示例值：monthly
LongTermActiveDays	否	String	指定用于长期保留的具体备份日期。此设置仅在 LongTermUnit 被设为weekly 或 monthly 时生效。 - 按周（weekly）保留：请输入 0-6 之间的数字来代表周日至周六。多个日期请用英文逗号分隔。 - 按月（monthly）保留：请输入 1-31 之间的数字来代表月份中的具体日期。多个日期请用英文逗号分隔。示例值：1,2
LongTermExpiredDays	否	Integer	长期备份保留时长。取值范围[30,1075]。示例值：30
OplogExpiredDays	否	Integer	增量备份保留时长。 - 单位：天。 - 默认值：7天。 - 取值范围：[7,365]。示例值：7
BackupVersion	否	Integer	指定备份版本。 - 旧版本备份：0。 - 开启高级备份：1。示例值：1
AlarmWaterLevel	否	Integer	设置备份数据集存储空间使用率的告警阈值。 - 单位：%。 - 默认值：100。 - 取值范围：[50,300]。示例值：100

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设置实例的自动备份规则

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetBackupRules
<公共请求参数>

{
    "InstanceId": "cmgo-********",
    "BackupFrequency": 24,
    "BackupTime": 22,
    "BackupMethod": 1,
    "BackupRetentionPeriod": 7,
    "Notify": true
}

输出示例

{
    "Response": {
        "RequestId": "58f3a6a0-2330-11ef-ad75-7139c2c3f68c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.CheckAppIdFailed	appId校验失败。

设置云数据库实例的自动备份规则

本页目录：