Elasticsearch Service 创建ES集群实例-API 文档-文档中心-腾讯云

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	可用区
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 节点数量（2-50个）
ChargeType	否	String	计费类型 PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：按小时后付费默认值POSTPAID_BY_HOUR
ChargePeriod	否	Integer	包年包月购买时长（单位由参数TimeUnit决定）
RenewFlag	否	String	自动续费标识 RENEW_FLAG_AUTO：自动续费 RENEW_FLAG_MANUAL：不自动续费，用户手动续费 ChargeType为PREPAID时需要设置，如不传递该参数，普通用户默认不自动续费，SVIP用户自动续费
NodeType	否	String	已废弃请使用NodeInfoList 节点规格 ES.S1.SMALL2：1核2G ES.S1.MEDIUM4：2核4G ES.S1.MEDIUM8：2核8G ES.S1.LARGE16：4核16G ES.S1.2XLARGE32：8核32G ES.S1.4XLARGE32：16核32G ES.S1.4XLARGE64：16核64G
DiskType	否	String	已废弃请使用NodeInfoList 节点磁盘类型 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高硬能云硬盘默认值CLOUD_SSD
DiskSize	否	Integer	已废弃请使用NodeInfoList 节点磁盘容量（单位GB）
TimeUnit	否	String	计费时长单位（ChargeType为PREPAID时需要设置，默认值为“m”，表示月，当前只支持“m”）
AutoVoucher	否	Integer	是否自动使用代金券 0：不自动使用 1：自动使用默认值0
VoucherIds.N	否	Array of String	代金券ID列表（目前仅支持指定一张代金券）
EnableDedicatedMaster	否	Boolean	已废弃请使用NodeInfoList 是否创建专用主节点 true：开启专用主节点 false：不开启专用主节点默认值false
MasterNodeNum	否	Integer	已废弃请使用NodeInfoList 专用主节点个数（只支持3个和5个，EnableDedicatedMaster为true时该值必传）
MasterNodeType	否	String	已废弃请使用NodeInfoList 专用主节点类型（EnableDedicatedMaster为true时必传） ES.S1.SMALL2：1核2G ES.S1.MEDIUM4：2核4G ES.S1.MEDIUM8：2核8G ES.S1.LARGE16：4核16G ES.S1.2XLARGE32：8核32G ES.S1.4XLARGE32：16核32G ES.S1.4XLARGE64：16核64G
MasterNodeDiskSize	否	Integer	已废弃请使用NodeInfoList 专用主节点磁盘大小（单位GB，非必传，若传递则必须为50，暂不支持自定义）
ClusterNameInConf	否	String	集群配置文件中的ClusterName（系统默认配置为实例ID，暂不支持自定义）
DeployMode	否	Integer	集群部署方式 0：单可用区部署 1：多可用区部署默认为0
MultiZoneInfo.N	否	Array of ZoneDetail	多可用区部署时可用区的详细信息(DeployMode为1时必传)
LicenseType	否	String	License类型 oss：开源版 basic：基础版 platinum：白金版默认值platinum
NodeInfoList.N	否	Array of NodeInfo	节点信息列表，用于描述集群各类节点的规格信息如节点类型，节点个数，节点规格，磁盘类型，磁盘大小等
TagList.N	否	Array of TagInfo	节点标签信息列表
BasicSecurityType	否	Integer	6.8（及以上版本）基础版是否开启xpack security认证 1：不开启 2：开启
SceneType	否	Integer	场景化模板类型 0：不启用 1：通用 2：日志 3：搜索
WebNodeTypeInfo	否	WebNodeTypeInfo	可视化节点配置
Protocol	否	String	创建https集群，默认是http
OperationDuration	否	OperationDuration	可维护时间段
EnableHybridStorage	否	Boolean	是否开启存算分离
DiskEnhance	否	Integer	是否开启essd 增强型云盘
EnableDiagnose	否	Boolean	是否开启智能巡检

3. 输出参数

参数名称	类型	描述
InstanceId	String	实例ID
DealName	String	订单号注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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": "xxxxxx",
    "InstanceName": "es_test"
}

输出示例

{
    "Response": {
        "InstanceId": "xx",
        "RequestId": "xx",
        "DealName": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.UnAuthorizedOperation	操作未授权。
FailedOperation.ClusterResourceLimitError	集群资源配额限制错误。
FailedOperation.DiskCountParamError	节点磁盘块数参数检查失败。
FailedOperation.NoPayment	账户未绑定信用卡或paypal，无法支付。
FailedOperation.NotAuthenticated	用户未实名认证。
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceInUse	资源被占用。
ResourceInsufficient	资源不足。
ResourceInsufficient.Balance	账户余额不足。
ResourceInsufficient.HiddenZone	隐藏可用区专用主节点资源不足。
ResourceInsufficient.Subnet	子网剩余ip数量不足。

产品动态

新手指引

产品简介

购买指南

ES 内核增强

快速入门

数据应用指南

Elasticsearch 指南

Logstash 指南

Beats 指南

最佳实践

API 文档

视频专区

常见问题

服务等级协议

联系我们

词汇表

创建ES集群实例

本页目录：