CreateDBInstance

Last updated: 2020-08-07 11:06:25

1. API Description

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

This API is used to create a monthly subscription TencentDB for MongoDB instance. The purchasable specifications supported by this API can be obtained through the DescribeSpecInfo API.

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: CreateDBInstance.
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.
NodeNum Yes Integer Number of nodes in each replica set. Currently, the number of nodes per replica set is fixed at 3, while the number of secondary nodes per shard is customizable. For more information, please see the parameter returned by the DescribeSpecInfo API.
Memory Yes Integer Instance memory size in GB.
Volume Yes Integer Instance disk size in GB.
MongoVersion Yes String Version number. For the specific purchasable versions supported, please see the return result of the DescribeSpecInfo API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition.
GoodsNum Yes Integer Number of instances. Minimum value: 1. Maximum value: 10.
Zone Yes String Instance region name in the format of ap-guangzhou-2.
Period Yes Integer Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
MachineCode Yes String Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).
ClusterType Yes String Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).
ReplicateSetNum Yes Integer Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the DescribeSpecInfo API; to create a single-node instance, set this parameter to 0.
ProjectId No Integer Project ID. If this parameter is not set, the default project will be used.
VpcId No String VPC ID. If this parameter is not set, the classic network will be used. Please use the DescribeVpcs API to query the VPC list.
SubnetId No String VPC subnet ID. If UniqVpcId is set, then UniqSubnetId will be required. Please use the DescribeSubnets API to query the subnet list.
Password No String Instance password. If this parameter is not set, you need to set an instance password through the SetPassword API after creating an instance. The password can only contain 8-16 characters and must contain at least two of the following types of characters: letters, digits, and special characters !@#%^*().
Tags.N No Array of TagInfo Instance tag information.
AutoRenewFlag No Integer Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.
AutoVoucher No Integer Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.
Clone No Integer Valid values: 1 (regular instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance).
Father No String Primary instance ID. It is required for read-only and disaster recovery instances.
SecurityGroup.N No Array of String Security group.

3. Output Parameters

Parameter Name Type Description
DealId String Order ID.
InstanceIds Array of String List of IDs of created instances.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a monthly subscription TencentDB instance

Input Example

https://mongodb.tencentcloudapi.com/?Action=CreateDBInstance
&Memory=4
&Volume=250
&GoodsNum=1
&Zone=ap-guangzhou-2
&UniqVpcId=vpc-0akbol5v
&UniqSubnetId=subnet-fyrtjbqw
&ProjectId=0
&MongoVersion=MONGO_3_WT
&MachineCode=TGIO
&NodeNum=3
&Period=1
&Password=pwd123456
&ClusterType=REPLSET
&ReplicateSetNum=1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "d88095e5-50e8-4245-a0cf-993a536f9b20",
    "DealId": "7142863",
    "InstanceIds": [
      "cmgo-po5f899l"
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InvalidParameter Invalid parameter.
InvalidParameter.PermissionDenied The current subaccount has no permission to perform this operation.
InvalidParameterValue.InvalidTradeOperation Billing error. Corresponding purchase/renewal/configuration change operations are not allowed for the current instance.
InvalidParameterValue.MachineTypeError Incorrect model.
InvalidParameterValue.MongoVersionError The instance version is incorrect.
InvalidParameterValue.NotFoundInstance The instance was not found.
InvalidParameterValue.PasswordRuleFailed The password is non-compliant.
InvalidParameterValue.ProjectNotFound The project does not exist.
InvalidParameterValue.RegionError Invalid region.
InvalidParameterValue.ReplicaSetNumError Incorrect number of replica sets (shards).
InvalidParameterValue.SecondaryNumError Incorrect number of secondary nodes.
InvalidParameterValue.SpecNotOnSale Incorrect purchasable specification.
InvalidParameterValue.TagNotFound The specified tag was not found.
InvalidParameterValue.VpcIdOrSubnetIdNotFound The VPC (subnet) was not found.
InvalidParameterValue.ZoneClosed Instances are not purchasable in this AZ.
InvalidParameterValue.ZoneError Invalid AZ.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help