云数据库 MongoDB 查询备份下载任务信息

1. 接口描述

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

本接口（DescribeBackupDownloadTask）用于查询备份下载任务信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupDownloadTask。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-74sjf5mt
BackupName	否	String	指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。示例值：cmgo-74sjf5mt_2021-03-24 15:40
StartTime	否	String	指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。示例值：2021-01-02 15:04:05
EndTime	否	String	指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。示例值：2021-01-02 15:04:05
Limit	否	Integer	此次查询返回的条数，取值范围为1-100，默认为20。示例值：10
Offset	否	Integer	指定此次查询返回的页数，默认为0。示例值：0
OrderBy	否	String	排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。示例值：finishTime
OrderByType	否	String	排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。示例值：desc
Status.N	否	Array of Integer	指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。示例值：[2]

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	满足查询条件的所有条数。示例值：12
Tasks	Array of BackupDownloadTask	下载任务列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询备份下载任务

输入示例

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

{
    "InstanceId": "cmgo-fdzf****",
    "Status": [
        "2"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "c7c0c495-4826-4938-a6d7-32146cad2632",
        "Tasks": [
            {
                "BackupDesc": "系统后台每日定时自动备份",
                "BackupMethod": 0,
                "BackupName": "cmgo-fdzf****_2025-09-23 22:03",
                "BackupSize": 5747378,
                "Bucket": "sh-backup-remote-125758****",
                "CreateTime": "2025-09-24 10:58:55",
                "Percent": 100,
                "Region": "ap-shanghai",
                "ReplicaSetId": "cmgo-fdzf******",
                "Status": 2,
                "TimeSpend": 1,
                "Url": "https://sh-backup-remote-tar-**************"
            }
        ],
        "TotalCount": 1
    }
}

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

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
InternalError	内部错误。
InvalidParameter.PermissionDenied	当前子账号无权执行该操作。
InvalidParameterValue.BackupFileNotFound	备份文件未找到。
InvalidParameterValue.NotFoundInstance	未找到实例。

查询备份下载任务信息

本页目录：