CreateBackupDBInstance

最后更新时间：2025-12-03 10:42:16

CreateBackupDBInstance

最后更新时间： 2025-12-03 10:42:16

1. API Description

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

This API is used to back up an instance.

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: CreateBackupDBInstance.
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. For example, cmgo-p8vn****. Log in to the TencentDB for MongoDB console and copy the instance ID from the instance list.
BackupMethod	Yes	Integer	Sets the backup method. - 0: logical backup. - 1: physical backup. - 3: snapshot backup. Note: 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. 2. Physical backup is not supported when storage encryption is enabled for the instance.
BackupRemark	No	String	Backup remarks information.

3. Output Parameters

Parameter Name	Type	Description
AsyncRequestId	String	Request ID.
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 Backing Up an Instance

This example shows how to back up an instance.

Input Example

https://mongodb.intl.tencentcloudapi.com/?Action=CreateBackupDBInstance
&InstanceId=cmgo-ayxpky6l
&BackupRemark=remarkInfo
&BackupMethod=0
&<Common request parameters>

Output Example

{
    "Response": {
        "AsyncRequestId": "1680780049",
        "RequestId": "1df930fb-eb7e-4e3f-bcab-15a1aa5fede0"
    }
}

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
FailedOperation.TransparentDataEncryptionAlreadyOpen	Physical backup is not supported when transparent data encryption is enabled for the instance.
InternalError	Internal error
InternalError.CheckAppIdFailed	`appId` verification failed.
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.
InvalidParameterValue.CheckAppIdFailed	`appId` verification failed.
InvalidParameterValue.IllegalInstanceStatus	Invalid instance status
InvalidParameterValue.NotFoundInstance	The instance was not found.
InvalidParameterValue.StatusAbnormal	The instance is in a status where operations are not allowed.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud