创建备份下载任务

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

我的收藏

1. 接口描述

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

本接口用来创建某个备份文件的下载任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBackupDownloadTask。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
示例值:cmgo-f555zzzz
BackupName String 要下载的备份文件名,可通过DescribeDBBackups接口获取。
示例值:cmgo-74sjf5mt_2021-03-24 15:40
BackupSets.N Array of ReplicaSetInfo 指定要下载的副本集的节点名称 或 分片集群的分片名称列表。
如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。

3. 输出参数

参数名称 类型 描述
Tasks Array of BackupDownloadTaskStatus 下载任务状态
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建备份下载任务

输入示例

https://mongodb.tencentcloudapi.com/?Action=CreateBackupDownloadTask
&InstanceId=cmgo-dygv1rnp
&BackupName=cmgo-dygv1rnp_2021-03-26 10:44
&BackupSets.0.ReplicaSetId=cmgo-dygv1rnp_0
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "6ed8d110-67be-4650-83b0-5df5a897e9e6",
        "Tasks": [
            {
                "ReplicaSetId": "cmgo-dygv1rnp_0",
                "Status": 2
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.CheckAppIdFailed appId校验失败。
InvalidParameter.PermissionDenied 当前子账号无权执行该操作。
InvalidParameterValue.BackupFileNotFound 备份文件未找到。
InvalidParameterValue.NotFoundInstance 未找到实例。