云数据库 MongoDB 设置云数据库实例的自动备份规则-API 文档-文档中心-腾讯云

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，例如：cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-p8vnipr5
BackupMethod	是	Integer	设置自动备份方式。- 0：逻辑备份。- 1：物理备份。-3：快照备份(仅云盘版支持)。示例值：1
BackupTime	是	Integer	设置自动备份开始时间。取值范围为：[0,23]，例如：该参数设置为2，表示02:00开始备份。示例值：2
Notify	否	Boolean	设置自动备份发生错误时，是否发送失败告警。 - true：发送。 - false：不发送。示例值：true
BackupRetentionPeriod	否	Integer	指定备份数据保存天数。默认为 7 天，支持设置为7、30、90、180、365。示例值：7

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-abcede",
    "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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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