1. 接口描述
接口请求域名: es.tencentcloudapi.com 。
创建指定规格的ES集群实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateInstance。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Zone | 是 | String | 可用区 示例值:ap-guangzhou-3 |
| EsVersion | 是 | String | 实例版本(支持"5.6.4"、"6.4.3"、"6.8.2"、"7.5.1"、"7.10.1") 示例值:6.4.3 |
| VpcId | 是 | String | 私有网络ID 示例值:vpc-xxxxxx |
| SubnetId | 是 | String | 子网ID 示例值:subnet-xxxxxx |
| Password | 是 | String | 访问密码(密码需8到16位,至少包括两项([a-z,A-Z],[0-9]和[-!@#$%&^+=_:;,.?]的特殊符号) 示例值:ascq23**cjaw |
| InstanceName | 否 | String | 实例名称(1-50 个英文、汉字、数字、连接线-或下划线_) 示例值:es_test |
| NodeNum | 否 | Integer | 已废弃请使用NodeInfoList 节点数量(2-50个) 示例值:3 |
| ChargeType | 否 | String | 计费类型 示例值:POSTPAID_BY_HOUR |
| ChargePeriod | 否 | Integer | 包年包月购买时长(单位由参数TimeUnit决定) 示例值:12 |
| RenewFlag | 否 | String | 自动续费标识 示例值:RENEW_FLAG_AUTO |
| NodeType | 否 | String | 已废弃请使用NodeInfoList 节点规格 示例值:ES.S1.4XLARGE64 |
| DiskType | 否 | String | 已废弃请使用NodeInfoList 节点磁盘类型 示例值:CLOUD_SSD |
| DiskSize | 否 | Integer | 已废弃请使用NodeInfoList 节点磁盘容量(单位GB) 示例值:500 |
| TimeUnit | 否 | String | 计费时长单位(ChargeType为PREPAID时需要设置,默认值为“m”,表示月,当前只支持“m”) 示例值:m |
| AutoVoucher | 否 | Integer | 是否自动使用代金券 示例值:0 |
| VoucherIds.N | 否 | Array of String | 代金券ID列表(目前仅支持指定一张代金券) 示例值:["1asdfa"] |
| EnableDedicatedMaster | 否 | Boolean | 已废弃请使用NodeInfoList 是否创建专用主节点 示例值:false |
| MasterNodeNum | 否 | Integer | 已废弃请使用NodeInfoList 专用主节点个数(只支持3个和5个,EnableDedicatedMaster为true时该值必传) 示例值:3 |
| MasterNodeType | 否 | String | 已废弃请使用NodeInfoList 专用主节点类型(EnableDedicatedMaster为true时必传) 示例值:ES.S1.4XLARGE64 |
| MasterNodeDiskSize | 否 | Integer | 已废弃请使用NodeInfoList 专用主节点磁盘大小(单位GB,非必传,若传递则必须为50,暂不支持自定义) 示例值:100 |
| ClusterNameInConf | 否 | String | 集群配置文件中的ClusterName(系统默认配置为实例ID,暂不支持自定义) 示例值:testnew |
| DeployMode | 否 | Integer | 集群部署方式 示例值:0 |
| MultiZoneInfo.N | 否 | Array of ZoneDetail | 多可用区部署时可用区的详细信息(DeployMode为1时必传) |
| LicenseType | 否 | String | License类型 示例值:platinum |
| NodeInfoList.N | 否 | Array of NodeInfo | 节点信息列表, 用于描述集群各类节点的规格信息如节点类型,节点个数,节点规格,磁盘类型,磁盘大小等 |
| TagList.N | 否 | Array of TagInfo | 节点标签信息列表 |
| BasicSecurityType | 否 | Integer | 6.8(及以上版本)基础版是否开启xpack security认证 示例值:2 |
| SceneType | 否 | Integer | 场景化模板类型 0:不启用 1:通用 2:日志 3:搜索 示例值:0 |
| WebNodeTypeInfo | 否 | WebNodeTypeInfo | 可视化节点配置 |
| Protocol | 否 | String | 创建https集群,默认是http 示例值:https |
| OperationDuration | 否 | OperationDuration | 可维护时间段 |
| EnableHybridStorage | 否 | Boolean | 是否开启存算分离 示例值:true |
| DiskEnhance | 否 | Integer | 是否开启essd 增强型云盘 示例值:0 |
| EnableDiagnose | 否 | Boolean | 是否开启智能巡检 示例值:false |
| CdcId | 否 | String | cdcId,使用cdc子网时传递 示例值:cluster-xxxxxx |
| DisasterRecoverGroupAffinity | 否 | Integer | 置放群组亲和度,范围[0,10],0表示不开启 示例值:1 |
| SubProductCode | 否 | String | 子产品ID枚举值: 开源版:"sp_es_io2", 基础版:"sp_es_basic",白金版:"sp_es_platinum",企业版:"sp_es_enterprise",CDC白金版:"sp_es_cdc_platinum",日志增强版:"sp_es_enlogging",tsearch:"sp_tsearch_io2",logstash:"sp_es_logstash" ,可以为空,为空的时候后台取LicenseType映射该字段 示例值:sp_es_platinum |
| ReadWriteMode | 否 | Integer | 读写分离模式:0-不开启,1-本地读写分离,2-远端读写分离 示例值:0 |
| EnableScheduleRecoverGroup | 否 | Boolean | 置放群组是否开启异步任务 示例值:false |
| EnableScheduleOperationDuration | 否 | EnableScheduleOperationDuration | 置放群组开启异步任务的可维护时间段 |
| AutoScaleDiskInfoList.N | 否 | Array of AutoScaleDiskInfo | 自动扩盘参数列表 |
| EnableKibanaPublicAccess | 否 | String | 是否开启kibana公网访问,不传默认开启 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值:es-xxxxxx |
| DealName | String | 订单号 注意:此字段可能返回 null,表示取不到有效值。 示例值:737749 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建ES集群实例
根据输入参数创建ES集群实例
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstance
<公共请求参数>
{
"EsVersion": "6.4.3",
"VpcId": "vpc-xxxxxx",
"NodeInfoList": [
{
"NodeType": "ES.S1.SMALL2",
"NodeNum": "3",
"Type": "dedicatedMaster"
},
{
"DiskSize": "100",
"NodeType": "ES.S1.SMALL2",
"NodeNum": "2",
"Type": "hotData",
"DiskType": "CLOUD_SSD"
}
],
"Zone": "ap-guangzhou-3",
"ChargeType": "POSTPAID_BY_HOUR",
"SubnetId": "subnet-xxxxxx",
"Password": "ascq23***********cjaw",
"InstanceName": "es_test"
}
输出示例
{
"Response": {
"InstanceId": "es-abc234",
"RequestId": "ab",
"DealName": "ab"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnAuthCreateInstance | 当前用户对创建集群实例操作未授权,请添加CAM权限 |
| AuthFailure.UnAuthorizedOperation | 操作未授权。 |
| FailedOperation.CdcQuotaInsufficient | 可用区资源包配额不足 |
| FailedOperation.ClusterResourceLimitError | 集群资源配额限制错误。 |
| FailedOperation.DiskCountParamError | 节点磁盘块数参数检查失败。 |
| FailedOperation.NoPayment | 账户未绑定信用卡或paypal,无法支付。 |
| FailedOperation.NodeNumAndZoneError | 节点数和可用区的信息不符合对应操作的规则。 |
| FailedOperation.NotAuthenticated | 用户未实名认证。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAutoVoucher | 是否自动使用代金券AutoVoucher的取值和预期不符。 |
| InvalidParameter.InvalidDeployMode | 集群部署方式InvalidDeployMode的取值和预期不符。 |
| InvalidParameter.InvalidDiskCount | 节点磁盘块数DiskCount取值和预期不符。 |
| InvalidParameter.InvalidDiskEncrypt | 节点磁盘加密信息DiskEncrypt的取值与预期不符。 |
| InvalidParameter.InvalidDiskEnhance | 是否启用增强型ssd云盘DiskEnhance的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidMultiZoneInfo | 多可用区部署ZoneDetail的信息与预期不符。 |
| InvalidParameter.InvalidNodeNum | 节点数量NodeNum的取值和预期不符。 |
| InvalidParameter.InvalidNodeType | 节点规格NodeType的取值和预期不符。 |
| InvalidParameter.InvalidOpType | 操作类型OpType的取值和预期不符。 |
| InvalidParameter.InvalidOperationDuration | 可维护时间段OperationDuration的取值和预期不符。 |
| InvalidParameter.InvalidRegion | 地域Region的取值与预期不符。 |
| InvalidParameter.InvalidTagList | 节点标签信息列表TagList的取值和预期不符。 |
| InvalidParameter.InvalidType | 节点类型Type的取值和预期不符。 |
| InvalidParameter.InvalidVoucherIds | 代金券ID列表VoucherIds的取值和预期不符。 |
| InvalidParameter.InvalidZone | 可用区Zone的信息与预期不符。 |
| InvalidParameterValue.ChargeType | 计费类型ChargeType的参数取值有误。 |
| InvalidParameterValue.RenewFlag | 自动续费标识RenewFlag的参数取值有误。 |
| LimitExceeded.ClusterNum | 该账号下的集群数超过限额。 |
| LimitExceeded.ResourceLimit | 超出一个用户可以拥有的最大资源限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInUse.Order | 订单被锁定。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.Balance | 账户余额不足。 |
| ResourceInsufficient.HiddenZone | 隐藏可用区专用主节点资源不足。 |
| ResourceInsufficient.Subnet | 子网剩余ip数量不足。 |
| ResourceInsufficient.Zone | 可用区资源不足。 |
| ResourceNotFound.DiskInfoNotFound | 磁盘相关资源获取失败。 |
| ResourceNotFound.TradeCgwNotFound | 获取计费资源失败。 |
| ResourceNotFound.VPCInfoNotFound | VPC资源获取失败。 |
| ResourceNotFound.WhiteListNotFound | 白名单资源获取失败。 |
| UnauthorizedOperation.UinNotInWhiteList | Uin不在白名单中。 |
| UnsupportedOperation.BasicSecurityType | 不支持该认证方式。 |
| UnsupportedOperation.LicenseError | 不支持该操作,license的类型有误。 |
| UnsupportedOperation.NotAgreement | 抱歉,您需要前往ES控制台购买页完成确认认证,我们才能为您提供所选的腾讯云服务。如果对于确认流程有任何疑问,可以联系我们:https://www.tencentcloud.com/zh/contact-us。 |
| UnsupportedOperation.SingleNodeClusterNotSupport | 单节点不支持该操作 |
| UnsupportedOperation.VPCInfoNotFound | VPC资源获取失败。 |