云数据库 MongoDB 查询实例备份列表

1. 接口描述

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

本接口（DescribeDBBackups）用于查询实例备份列表，目前只支持查询7天内的备份记录。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBBackups。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-f555zzzz
BackupMethod	否	Integer	备份方式。 - 0：逻辑备份。 - 1：物理备份。 - 3：快照备份。说明: 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。 2. 实例开通存储加密，则备份方式不能为物理备份。示例值：1
Limit	否	Integer	分页大小，最大值为100，不设置默认查询所有。示例值：10
Offset	否	Integer	分页偏移量，最小值为0，默认值为0。示例值：1

3. 输出参数

参数名称	类型	描述
BackupList	Array of BackupInfo	备份列表。
TotalCount	Integer	备份总数。示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云数据库实例的备份文件信息

输入示例

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

{
    "InstanceId": "cmgo-fdzf****",
    "BackupMethod": 0
}

输出示例

{
    "Response": {
        "BackupList": [
            {
                "BackId": 10657020,
                "BackupDesc": "系统后台每日定时自动备份",
                "BackupMethod": 0,
                "BackupName": "cmgo-fdzf****_2025-09-17 22:01",
                "BackupRegion": "",
                "BackupSize": 5747379,
                "BackupType": 0,
                "DeleteTime": "2025-09-24 22:01:58",
                "EndTime": "2025-09-17 22:01:58",
                "InstanceId": "cmgo-fdzf****",
                "RestoreTime": "",
                "StartTime": "2025-09-17 22:01:52",
                "Status": 2
            },
            {
                "BackId": 10688339,
                "BackupDesc": "系统后台每日定时自动备份",
                "BackupMethod": 0,
                "BackupName": "cmgo-fdzf****_2025-09-18 22:03",
                "BackupRegion": "ap-shanghai",
                "BackupSize": 5747378,
                "BackupType": 0,
                "DeleteTime": "2025-09-20 22:03:37",
                "EndTime": "2025-09-18 22:03:44",
                "InstanceId": "cmgo-fdzf****",
                "RestoreTime": "",
                "StartTime": "2025-09-18 22:03:42",
                "Status": 2
            }
        ],
        "RequestId": "0e2eb0e1-f775-4ba8-af9f-e5650a55dce1",
        "TotalCount": 2
    }
}

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. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InvalidParameter.PermissionDenied	当前子账号无权执行该操作。
InvalidParameterValue.NotFoundInstance	未找到实例。

查询实例备份列表

本页目录：