Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to create a parameter template for TencentDB for MongoDB.
Description: The CreateDBInstanceParamTpl API is in public beta. During this period, this API is only applicable to beta test participants.
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: CreateDBInstanceParamTpl. |
| 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. |
| TplName | Yes | String | Parameter template name. |
| MongoVersion | No | String | Template version number. This field is required when MirrorTplId is empty. For the purchasable versions supported by the parameter template, use the interface DescribeSpecInfo. - MONGO_36_WT: Version of the MongoDB 3.6 WiredTiger storage engine. - MONGO_40_WT: Version of the MongoDB 4.0 WiredTiger storage engine. - MONGO_42_WT: Version of the MongoDB 4.2 WiredTiger storage engine. - MONGO_44_WT: Version of the MongoDB 4.4 WiredTiger storage engine. - MONGO_50_WT: Version of the MongoDB 5.0 WiredTiger storage engine. - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. - MONGO_80_WT: version of the MongoDB 8.0 WiredTiger storage engine. |
| ClusterType | No | String | Instance type. This parameter is required when MirrorTplId is empty. - REPLSET: replica set instance. - SHARD: shard instance. -STANDALONE: Single-node instance. |
| TplDesc | No | String | Template description information. |
| Params.N | No | Array of ParamType | Template parameter. If this parameter is not configured, the system default template is used as the version parameter. |
| MirrorTplId | No | String | Image template ID. If an image template is specified, a new template is cloned from this template. Note: When MirrorTplId is not empty, MongoVersion and ClusterType will follow the template version and instance type of MirrorTpl. |
| Parameter Name | Type | Description |
|---|---|---|
| TplId | String | Template 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. |
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstanceParamTpl
<Common request parameters>
{
"ClusterType": "SHARD",
"MongoVersion": "MONGO_44_WT",
"TplDesc": "",
"TplName": "test-4.4"
}
{
"Response": {
"RequestId": "f3924f2d-6b76-4fe3-b705-1e0144049b90",
"TplId": "tpl-bi5f78srm"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback