1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(CreateDBInstanceParamTpl)用于创建云数据库MongoDB实例的参数模板
说明:CreateDBInstanceParamTpl API正在公测中,在此期间,该接口仅对公测用户开放
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDBInstanceParamTpl。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-25。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TplName | 是 | String | 参数模板名称。 示例值:高性能模板 |
MongoVersion | 否 | String | 版本号,该参数模板支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是:MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。当MirrorTplId为空时,该字段必填。 示例值:MONGO_42_WT |
ClusterType | 否 | String | 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点 当MirrorTplId为空时,该字段必填。 示例值:SHARD |
TplDesc | 否 | String | 模板描述信息。 示例值:用于压测场景 |
Params.N | 否 | Array of ParamType | 模板参数,若为空,则以系统默认模板作为新版本参数。 |
MirrorTplId | 否 | String | 镜像模板ID,若该字段不为空,则以该模板为镜像,克隆出一个新的模板。注意:MirrorTplId不为空时,MongoVersion及ClusterType将以MirrorTpl模板的版本及实例类型为准。 示例值:tpl-sdah144hg |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TplId | String | 模板ID 示例值:tpl-sdah144hg |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建参数模板
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstanceParamTpl
<公共请求参数>
{
"ClusterType": "SHARD",
"MongoVersion": "MONGO_44_WT",
"TplDesc": "",
"TplName": "test-4.4"
}
输出示例
{
"Response": {
"RequestId": "f3924f2d-6b76-4fe3-b705-1e0144049b90",
"TplId": "tpl-bi5f78srm"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。