云数据库 MongoDB 获取云数据库实例自动备份配置

1. 接口描述

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

本接口（DescribeBackupRules）用于获取实例自动备份配置信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupRules。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	指定实例ID。例如：cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-7pjedvz7

3. 输出参数

参数名称	类型	描述
BackupSaveTime	Integer	备份数据保留期限。单位为：天。示例值：7
BackupFrequency	Integer	备份频率。备份时间间隔，单位小时。取值12，24 示例值：24
BackupTime	Integer	自动备份开始时间。示例值：1
BackupMethod	Integer	备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。说明: 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 2. 实例开通存储加密，则备份方式不能为物理备份。示例值：1
ActiveWeekdays	String	周几备份，0-6，逗号分割示例值：0,1,2,3
LongTermInterval	String	长期备份周期。weekly-按周，monthly-按月，空不开启。示例值：monthly
LongTermActiveDays	String	长期备份的日期，周0-6，月1-31 示例值：0,1
LongTermExpiredDays	Integer	长期备份保留时间示例值：30
OplogExpiredDays	Integer	增量备份保留时间示例值：7
BackupVersion	Integer	备份版本号。0-旧备份方式，1-高级备份示例值：1
BackupTotalSize	BackupTotalSize	备份大小
AlertThreshold	Integer	告警额度示例值：100
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例备份规则

输入示例

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

{
    "InstanceId": "cmgo-xxxxx"
}

输出示例

{
    "Response": {
        "ActiveWeekdays": "0,1,2,3,4,5,6",
        "AlertThreshold": 0,
        "BackupFrequency": 12,
        "BackupMethod": 0,
        "BackupSaveTime": 7,
        "BackupTime": 0,
        "BackupTotalSize": {
            "FreeQuota": 10737418240,
            "OplogSize": 602372,
            "SnapshotSize": 28916
        },
        "BackupVersion": 1,
        "LongTermActiveDays": "",
        "LongTermExpiredDays": 0,
        "LongTermInterval": "",
        "OplogExpiredDays": 0,
        "RequestId": "b544304c-e8eb-4819-8715-05a005c010ca"
    }
}

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	内部错误。
InternalError.CheckAppIdFailed	appId校验失败。

获取云数据库实例自动备份配置

本页目录：