CreateBackupDownloadTask

Last updated: 2025-12-03 10:42:16

CreateBackupDownloadTask

Last updated: 2025-12-03 10:42:16

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to create a backup download task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: CreateBackupDownloadTask.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list.
BackupName	Yes	String	Name of the backup file to be downloaded. The DescribeDBBackups API can be called to obtain it.
BackupSets.N	Yes	Array of ReplicaSetInfo	Specifies the node ID of the replica set to be downloaded or the shard node ID list of the sharded cluster. - If the replica set instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0, full data can be downloaded. - If the sharded cluster instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1, download the data of Shard 0 and Shard 1. If a full download is needed for the sharded cluster, import all shard names as shown in the example.

3. Output Parameters

Parameter Name	Type	Description
Tasks	Array of BackupDownloadTaskStatus	Status of the download task.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a backup download task

Input Example

https://mongodb.intl.tencentcloudapi.com/?Action=CreateBackupDownloadTask
&InstanceId=cmgo-dygv1rnp
&BackupName=cmgo-dygv1rnp_2021-03-26 10:44
&BackupSets.0.ReplicaSetId=cmgo-dygv1rnp_0
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error
InternalError.CheckAppIdFailed	`appId` verification failed.
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.
InvalidParameterValue.BackupFileNotFound	The backup file was not found.
InvalidParameterValue.NotFoundInstance	The instance was not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud