全部文档
当前文档
最近更新时间：2024-09-02 11:39:52
接口请求地址：https://kes.region.api.ksyun.com
调用LaunchCluster，创建指定规格的ES集群
默认接口请求频率限制：30次/秒
名称 | 类型 | 是否可缺省 | 示例 | 有效值 | 备注 |
|---|---|---|---|---|---|
VpcSubnetId | string | 否 | 账号下同数据中心同可用区可用云服务器子网 | 云服务器网络，节点资源有KEC资源则必填 | |
VpcEpcSubnetId | string | 否 | 账号下同数据中心同可用区可用裸金属服务器子网 | 云物理机网络，节点资源有裸金属资源则必填 | |
VpcDomainId | string | 是 | 账号下同数据中心可用VPC网络 | VPC网络 | |
SecurityGroupId | strig | 否 | 账号下KES产品线可用安全组。标准UUID格式，形如[1]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ | 安全组ID，若不填则默认创建新的安全组 | |
PurchaseTime | int | 否 | 3 | 1-36 | 购买时长，当计费类型为Monthly（包年包月）时，需要传此参数，其他计费类型时不需要 |
ProjectId | long | 否 | 0 | 账号有权限的所有项目ID，0为默认项目 | 项目ID |
MainVersion | string | 是 | 6.8.4 | 7.10.0，7.4.2，6.8.4，5.6.16 | ES版本 |
EipLineId | string | 否 | BGP | UUID | EIP链路，购买弹性IP时必填 |
InstanceGroups | object [] | 是 | 节点组列表标识 | ||
EnableEip | boolean | 否 | true | true，false | 是否开启EIP，不传默认为false |
EipId | 绑定，EIPID | ||||
ClusterName | string | 否 | es-test | 长度限制为1-25个字符，支持数字、大小写字母、减号和下划线 | 集群名称，如果未指定，则自动生成 |
ChargeType | string | 是 | Monthly | Monthly(包年包月）、Daily（按量付费（按日月结）)、 HourlyInstantSettlement（按量付费） | 计费方式 |
AvailabilityZone | string | 是 | cn-beijing-6a | 集群数据中心及可用区 | |
EipPurchaseTime | int | 否 | 3 | 1-36 | 弹性IP的购买时长，当计费类型为Monthly（包年包月）时，需要传此参数，其他计费类型时不需要 |
EipChargeType | string | 否 | Monthly | Monthly：包年包月，Peak：按量付费（月峰值），Daily：按量付费（按日月结），TrafficMonthly：按量付费（流量月结），DailyPaidByTransfer：按量付费（流量），HourlyInstantSettlement：按量付费 | EIP计费方式，可不传，默认不绑定弹性IP |
EipBandWidth | int | 否 | 5 | 大于等于1，不超过账号最大购买带宽 | EIP带宽，购买弹性IP时必填 |
–VolumeType | string | 是否 | SSD3.0，Local_SSD | 存储类型，Master（专有主节点）、COORDINATOR（协调节点）、WARM（冷数据节点） | |
–VolumeSize | int | 是否 | 5000 | 20-16000 | 存储大小，单位为G。MASTER（专有主节点）、COORDINATOR（协调节点）大小默认为20G,EPC\D4不传，KEC必传 |
–ResourceType | string | 否 | KEC | KEC/EPC，若不填默认KEC | 资源类型，MASTER（专有主节点）、COORDINATOR（协调节点）、WARM（冷数据节点）只支持KEC |
–RaidType | string | 否 | Raid0,Raid1,Raid5,Raid50,Raid10, | SRaid0 | 云物理机raid方式，若资源类型为EPC，需要选择物理机raid方式，KEC不需要 |
–MultiInstanceCount | int | 否 | 4 | 单节点实例个数，EPC不填默认1，非EPC无效 | |
–InstanceType | string | 是 | ES.I3.2C4G | ES.I3.2C4G,EPC: CAL-ES.epc.32C256G,D4: D4.3B-ES.D4.4C4G | 节点组套餐，节点组套餐code |
–InstanceGroupType | string | 是 | DATA | MASTER（专有主节点）、DATA（数据节点）、COORDINATOR（协调节点）、WARM（冷数据节点） | 节点类型 |
–InstanceCount | int | 是 | 5 | 1-255 | 节点数量，MASTER（专有主节点）节点数量默认为3 |
名称 | 类型 | 是否可缺省 | 示例 | 备注 | 其他 |
|---|---|---|---|---|---|
RequestId | string | YES | uuid | 标准响应 | |
ClusterId | string | YES | uuid | ||
ErrorCode | int | NO | 400 | 错误响应。参考通用错误码定义 | |
ErrorMessage | string | NO | error parmaters | 错误响应。如果是同步请求，随请求返回 |
创建ES集群
输入示例
curl -X POST http://127.0.0.1:28081/kes/v1/LaunchCluster -H 'X-Ksc-Account-Id: 73403574' -H 'X-Ksc-Region: cn-shanghai-3' -H 'X-Ksc-Source:user' -H 'X-Ksc-Request-Id: 0b09eb45-e650-4a6d-be49-14b533abcf64' -H 'X-Version: 2020-12-15' -d '{
"ChargeType":"Daily",
"AvailabilityZone":"cn-shanghai-3a",
"MainVersion":"7.4.2",
"ClusterName":"kes-wq-d4",
"PurchaseTime":1,
"InstanceGroups":[
{
"InstanceGroupType":"DATA",
"InstanceCount":3,
"InstanceType":"ES.D4.8C16G"
}
],
"VpcDomainId":"19b422fa-74b2-45ac-8b03-fe4d955f27cc",
"VpcSubnetId":"ba386dfa-a518-4078-b0c1-962609e7a285"
}'
输出示例
正常
{
RequestId: "uuid", //任务ID
ClusterId: "uuid" //集群ID
}
异常
{
RequestId:"uuid", //任务ID
ErrorCode: 400, //错误响应。参考通用错误码定义
ErrorMessage: "" //错误响应。如果是同步请求，随请求返回
}
0-9a-f ↩︎
纯净模式