tencent cloud

Feedback

CreateBackupDownloadTask

Last updated: 2022-04-20 15:20:59

1. API Description

Domain name for API request: mongodb.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 in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.
BackupName Yes String The name of the backup file to be downloaded, which can be obtained by the DescribeDBBackups API.
BackupSets.N Yes Array of ReplicaSetInfo Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded.
Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code BackupSets.0=cmgo-p8vnipr5_0 to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0".
Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1 to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.

3. Output Parameters

Parameter Name Type Description
Tasks Array of BackupDownloadTaskStatus Download task status
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a backup download task

Input Example

https://mongodb.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

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 subaccount has no permission to perform this operation.
InvalidParameterValue.BackupFileNotFound The backup file was not found.
InvalidParameterValue.NotFoundInstance The instance was not found.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support