CreateBackupDBInstance

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-04-13 15:35:08

Download PDF

1. API Description

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

This API is used to create instance backups.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mongodb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateBackupDBInstance.
Version	Yes	String	Common parameter. The value used for this API: 2019-07-25.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID
BackupMethod	Yes	Integer	Valid values: 0 (logical backup), 1 (physical backup)
BackupRemark	No	String	Backup remarks

3. Output Parameters

Parameter Name	Type	Description
AsyncRequestId	String	The status of the queried backup process.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating instance backups

Input Example

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

Output Example

{
  "Response": {
    "AsyncRequestId": 4773,
    "RequestId": "e600a8d0-9014-11ea-84c1-01cccde830c6"
  }
}

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
InvalidParameter.PermissionDenied	The current subaccount 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.

Recent Pages