云数据库 MongoDB
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 云数据库 MongoDB > API 文档 > 备份相关接口 > 查询备份下载任务信息

查询备份下载任务信息

最近更新时间：2024-03-12 01:40:20

我的收藏

本页目录：

1. 接口描述

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

查询备份下载任务信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBackupDownloadTask。
Version 是 String 公共参数，本接口取值：2019-07-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
示例值：cmgo-74sjf5mt
BackupName 否 String 备份文件名，用来过滤指定文件的下载任务
示例值：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，finishTime两种，默认为createTime
示例值：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 查询备份下载任务

输入示例

https://mongodb.tencentcloudapi.com/?Action=DescribeBackupDownloadTask
&InstanceId=cmgo-dygv1rnp
&Status.0=2
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "c41c0c46-7d5a-49b9-832a-557880c1e9ef",
        "Tasks": [
            {
                "BackupName": "cmgo-dygv1rnp_2021-03-26 10:44",
                "BackupSize": 844,
                "CreateTime": "2021-03-26 10:47:37",
                "Percent": 100,
                "ReplicaSetId": "cmgo-dygv1rnp_0",
                "Status": 2,
                "TimeSpend": 0,
                "Url": "https://mognodb-backup-test-tar-1251937656.cos.ap-guangzhou.myqcloud.com/cmgo-dygv1rnp_2021-03-26%2010%3A44%2Fcmgo-dygv1rnp_0.tar?q-sign-algorithm=sha1&q-ak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&q-sign-time=1616726859%3B1616813259&q-key-time=1616726859%3B1616813259&q-header-list=host&q-url-param-list=&q-signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
            }
        ],
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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