1. 接口描述
接口请求域名： tse.tencentcloudapi.com 。
创建引擎实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateEngine。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。 |
| EngineType | 是 | String | 引擎类型。参考值： - zookeeper - nacos - consul - apollo - eureka - polaris 示例值：zookeeper |
| EngineVersion | 是 | String | 引擎的开源版本。每种引擎支持的开源版本不同，请参考产品文档或者控制台购买页 示例值：3.5.9 |
| EngineProductVersion | 是 | String | 引擎的产品版本。参考值： - STANDARD： 标准版 - PROFESSIONAL: 专业版（Zookeeper）/企业版（PolarisMesh） 引擎各版本及可选择的规格、节点数说明： apollo - STANDARD版本 规格列表：1C2G、2C4G、4C8G、8C16G、16C32G 节点数：1，2，3，4，5 eureka - STANDARD版本 规格列表：1C2G、2C4G、4C8G、8C16G、16C32G 节点数：3，4，5 polarismesh - STANDARD版本 规格列表：NUM50、NUM100、NUM200、NUM500、NUM1000、NUM5000、NUM10000、NUM50000 兼容原spec-xxxxxx形式的规格ID 示例值：STANDARD |
| EngineRegion | 是 | String | 引擎所在地域。参考值说明： 中国区 参考值： - ap-guangzhou：广州 - ap-beijing：北京 - ap-chengdu：成都 - ap-chongqing：重庆 - ap-nanjing：南京 - ap-shanghai：上海 - ap-hongkong：香港 - ap-taipei：台北 亚太区 参考值： - ap-jakarta：雅加达 - ap-singapore：新加坡 北美区 参考值 - na-siliconvalley：硅谷 - na-ashburn: 弗吉尼亚 金融专区 参考值 - ap-beijing-fsi：北京金融 - ap-shanghai-fsi：上海金融 - ap-shenzhen-fsi：深圳金融 示例值：ap-beijing |
| EngineName | 是 | String | 引擎名称。参考值： - eurek-test 示例值：qzone-photo-prod |
| TradeType | 是 | Integer | 付费类型。参考值： - 0：后付费 - 1：预付费（接口暂不支持创建预付费实例） 示例值：0 |
| EngineResourceSpec | 否 | String | 引擎的节点规格 ID。参见EngineProductVersion字段说明 示例值：1C2G |
| EngineNodeNum | 否 | Integer | 引擎的节点数量。参见EngineProductVersion字段说明 示例值：3 |
| VpcId | 否 | String | VPC ID。在 VPC 的子网内分配一个 IP 作为引擎的访问地址。参考值： - vpc-conz6aix 示例值：vpc-xxxxxx |
| SubnetId | 否 | String | 子网 ID。在 VPC 的子网内分配一个 IP 作为引擎的访问地址。参考值： - subnet-ahde9me9 示例值：subnet-xxxxxx |
| ApolloEnvParams.N | 否 | Array of ApolloEnvParam | Apollo 环境配置参数列表。参数说明： 如果创建Apollo类型，此参数为必填的环境信息列表，最多可选4个环境。环境信息参数说明： - Name：环境名。参考值：prod, dev, fat, uat - EngineResourceSpec：环境内引擎的节点规格ID。参见EngineProductVersion参数说明 - EngineNodeNum：环境内引擎的节点数量。参见EngineProductVersion参数说明，其中prod环境支持的节点数为2，3，4，5 - StorageCapacity：配置存储空间大小，以GB为单位，步长为5.参考值：35 - VpcId：VPC ID。参考值：vpc-conz6aix - SubnetId：子网 ID。参考值：subnet-ahde9me9 示例值：[{"EnvName":"pro","StorageCapacity":50,"EngineResourceSpec":"spec-xxx","EngineNodeNum":1}] |
| EngineTags.N | 否 | Array of InstanceTagInfo | 引擎的标签列表。用户自定义的key/value形式，无参考值 示例值：[{"key":"value"}] |
| EngineAdmin | 否 | EngineAdmin | 引擎的初始账号信息。可设置参数： - Name：控制台初始用户名 - Password：控制台初始密码 - Token：引擎接口的管理员 Token 示例值：{"Name":"nacos","Password":"xxxxxx","Token":"xxxxxx"} |
| PrepaidPeriod | 否 | Integer | 预付费时长，以月为单位 示例值：1 |
| PrepaidRenewFlag | 否 | Integer | 自动续费标记，仅预付费使用。参考值： - 0：不自动续费 - 1：自动续费 示例值：0 |
| EngineRegionInfos.N | 否 | Array of EngineRegionInfo | 跨地域部署的引擎地域配置详情 zk标准版没有跨地域部署，请不要填写 zk专业版跨地域部署开启了固定Leader所在地域，需要满足以下条件 - 固定Leader所在地域当前仅支持跨两个地域 - leader地域的副本数必须是3/2 + 1，5/2+1，7/2+1，也就是 2，3，4 示例值：[{"EngineRegion":"ap-guangzhou","Replica":2,"SpecId":"1C2G","VpcInfos":[{"VpcId":"vpc-XXX","SubnetId":"subnet-XXX"}]},{"EngineRegion":"ap-beijing","Replica":1,"SpecId":"1C2G","VpcInfos":[{"VpcId":"vpc-XXX","SubnetId":"subnet-XXX"}]}] |
| StorageType | 否 | String | zk标准版请填CLOUD_PREMIUM，zk标准版无法选择磁盘类型和磁盘容量，默认为CLOUD_PREMIUM zk专业版可以为：CLOUD_SSD,CLOUD_SSD_PLUS,CLOUD_PREMIUM 示例值：CLOUD_SSD |
| StorageCapacity | 否 | Integer | zk标准版请填50，zk标准版无法选择磁盘类型和磁盘容量，磁盘容量默认为50 示例值：50 |
| StorageOption.N | 否 | Array of StorageOption | zk专业版至多有两个盘，且磁盘的容量在50-3200之间 如果只有一个磁盘，storageCapacity与storageOption里面的capacity应该一致 |
| AffinityConstraint | 否 | String | ZK引擎实例，可用区分布约束，STRICT:强约束，PERMISSIVE: 弱约束 示例值：STRICT |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 引擎实例 ID 示例值：ins-12345678 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建引擎实例
创建引擎实例
输入示例
https://tse.tencentcloudapi.com/?Action=CreateEngine
&EngineType=zookeeper
&EngineVersion=3.4.14
&EngineProductVersion=STANDARD
&EngineRegion=ap-beijing
&EngineResourceSpec=spec-xxxxxx
&EngineNodeNum=3
&VpcId=vpc-xxxxxx
&SubnetId=subnet-xxxxxx
&EngineName=qzone-photo-prod
&TradeType=0
&ReportPolarisLogToCLS=false
&<公共请求参数>输出示例
{
"Response": {
"InstanceId": "ins-123",
"RequestId": "11111-1111-1111-11111"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 未授权操作错误。 |
| InternalError.CreateError | 创建内部错误。 |
| InternalError.GetCredential | 获取凭证失败。 |
| InternalError.TKEFailure | TKE相关操作失败。 |
| InternalError.UnknownError | 未知错误。 |
| InternalError.VPCFailure | 访问VPC内部错误。 |
| InvalidParameterValue.BadRequestFormat | 请求格式不正确。 |
| InvalidParameterValue.CreateError | 无效请求参数导致创建失败。 |
| InvalidParameterValue.QueryError | 无效请求参数，查询失败。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter.CreateError | 缺失参数导致创建失败。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.CamPassRoleNotExist | 子账号缺少passRole权限。 |
