接口请求域名： es.intl.tencentcloudapi.com 。
创建指定规格的ES集群实例
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Zone | 是 | String | 可用区 |
| EsVersion | 是 | String | 实例版本（支持"5.6.4"、"6.4.3"、"6.8.2"、"7.5.1"、"7.10.1"） |
| VpcId | 是 | String | 私有网络ID |
| SubnetId | 是 | String | 子网ID |
| Password | 是 | String | 访问密码（密码需8到16位，至少包括两项（[a-z,A-Z],[0-9]和[-!@#$%&^*+=_:;,.?]的特殊符号） |
| InstanceName | 否 | String | 实例名称（1-50 个英文、汉字、数字、连接线-或下划线_） |
| NodeNum | 否 | Integer | 已废弃请使用NodeInfoList |
| ChargeType | 否 | String | 计费类型 |
| ChargePeriod | 否 | Integer | 国际站无用参数 |
| RenewFlag | 否 | String | 国际站无用参数 |
| NodeType | 否 | String | 已废弃请使用NodeInfoList |
| DiskType | 否 | String | 已废弃请使用NodeInfoList |
| DiskSize | 否 | Integer | 已废弃请使用NodeInfoList |
| TimeUnit | 否 | String | 国际站无用参数 |
| AutoVoucher | 否 | Integer | 是否自动使用代金券 |
| VoucherIds.N | 否 | Array of String | 代金券ID列表（目前仅支持指定一张代金券） |
| EnableDedicatedMaster | 否 | Boolean | 已废弃请使用NodeInfoList |
| MasterNodeNum | 否 | Integer | 已废弃请使用NodeInfoList |
| MasterNodeType | 否 | String | 已废弃请使用NodeInfoList |
| MasterNodeDiskSize | 否 | Integer | 已废弃请使用NodeInfoList |
| ClusterNameInConf | 否 | String | 集群配置文件中的ClusterName（系统默认配置为实例ID，暂不支持自定义） |
| DeployMode | 否 | Integer | 集群部署方式 |
| MultiZoneInfo.N | 否 | Array of ZoneDetail | 多可用区部署时可用区的详细信息(DeployMode为1时必传) |
| LicenseType | 否 | String | License类型 |
| NodeInfoList.N | 否 | Array of NodeInfo | 节点信息列表， 用于描述集群各类节点的规格信息如节点类型，节点个数，节点规格，磁盘类型，磁盘大小等 |
| TagList.N | 否 | Array of TagInfo | 节点标签信息列表 |
| BasicSecurityType | 否 | Integer | 6.8（及以上版本）基础版是否开启xpack security认证 |
| SceneType | 否 | Integer | 场景化模板类型 0：不启用 1：通用 2：日志 3：搜索 |
| WebNodeTypeInfo | 否 | WebNodeTypeInfo | 可视化节点配置 |
| Protocol | 否 | String | 创建https集群，默认是http |
| OperationDuration | 否 | OperationDuration | 可维护时间段 |
| EnableHybridStorage | 否 | Boolean | 是否开启存算分离 |
| DiskEnhance | 否 | Integer | 硬盘额外性能 |
| EnableDiagnose | 否 | Boolean | 是否开启智能巡检 |
| CdcId | 否 | String | cdcId，使用cdc子网时传递 |
| DisasterRecoverGroupAffinity | 否 | Integer | 置放群组亲和度，范围[0,10]，0表示不开启 |
| 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映射该字段 |
| ReadWriteMode | 否 | Integer | 读写分离模式：0-不开启，1-本地读写分离，2-远端读写分离 |
| EnableScheduleRecoverGroup | 否 | Boolean | 置放群组是否开启异步任务 |
| EnableScheduleOperationDuration | 否 | EnableScheduleOperationDuration | 置放群组开启异步任务的可维护时间段 |
| AutoScaleDiskInfoList.N | 否 | Array of AutoScaleDiskInfo | 自动扩盘参数列表 |
| EnableKibanaPublicAccess | 否 | String | 是否开启kibana公网访问，不传默认开启 |
| AlarmPolicyIds.N | 否 | Array of String | 已有的云监控告警策略 ID |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID |
| DealName | String | 订单号 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
根据输入参数创建ES集群实例
POST / HTTP/1.1
Host: es.intl.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"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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资源获取失败。 |
文档反馈