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.
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 | No | String | Common Params. This parameter is not required for this API. |
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. |
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. |
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>
{
"Response": {
"RequestId": "6ed8d110-67be-4650-83b0-5df5a897e9e6",
"Tasks": [
{
"ReplicaSetId": "cmgo-dygv1rnp_0",
"Status": 2
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?