全部文档
当前文档
最近更新时间：2023-08-29 11:15:46
接口请求地址：https://kes.region.api.ksyun.com
调用ScaleOutInstanceGroups，执行ES集群扩容操作
默认接口请求频率限制：30次/秒
| 名称 | 类型 | 是否可缺省 | 示例 | 有效值 | 备注 |
|---|---|---|---|---|---|
| ClusterId | string | YES | uuid | 集群ID | |
| InstanceGroups | string[] | YES | [] | 扩容节点组标识 | |
| InstanceGroupType | string | YES | DATA | MASTER（专有主节点）、DATA（数据节点）、COORDINATOR（协调节点）、WARM（冷数据节点） | 单次只能操作一个节点组 |
| InstanceStatus | boolean | YES | 1 | 0(已有节点组），1（新开节点组） | 是否新开节点组 |
| InstanceType | string | NO | ES.I3.2C4G | ES.I3.2C4G | 节点组套餐code，已有节点组扩容该参数无效，新开节点组必填 |
| InstanceCount | int | YES | 4 | 扩容数量，若已有节点组为新增数量，新开节点组为节点组内节点数量 | 必须 |
| VolumeType | string | NO | SSD3.0/Local_SSD | 磁盘类型 | 存储类型，Master（专有主节点）、COORDINATOR（协调节点）、WARM（冷数据节点）仅支持SSD3.0。已有节点组扩容该参数无效，新开节点组必填 |
| VolumeSize | int | NO | 2000 | 数据盘大小 | 已有节点组扩容该参数无效，新开节点组必填 |
| ProjectId | long | 否 | 0 | 账号有权限的所有项目ID，0为默认项目 | 项目ID |
| 名称 | 类型 | 是否可缺省 | 示例 | 备注 | 其他 |
|---|---|---|---|---|---|
| RequestId | string | YES | uuid | 标准响应 | |
| ClusterId | string | YES | uuid | ||
| ErrorCode | int | NO | 400 | 错误响应。参考通用错误码定义 | |
| ErrorMessage | string | NO | error parmaters | 错误响应。如果是同步请求，随请求返回 |
输入示例
curl -X POST http://127.0.0.1:28081/kes/v1/ScaleOutInstanceGroups -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
'{//commonRequestId: "uuid",
DryRun: false,ClusterId: "uuid",
InstanceGroups: [{
Id: "xxx",InstanceGroupType: "DATA | WARM_DATA",
ResourceType: "KEC|EPC|CONTAINER",
InstanceType: "kmr.2x | I3.2b",
InstanceCount: 4,
ResouceAttributes: [{
Name: "bandwidth",
Value: "2000"},
{
Name: "pps",
Value: "500000"
},
{
Name: "bond_type",
Value: "0"
},{
Name: "raid_type",
Value: "raid50"}],
VolumeType: "CLOUD_SSD",
VolumeSize: 2000,
VolumeCount: 3,
VpcId: "uuid",
VpcSubnetId: "uuid",
AvalabilityZone: "cn-beijing-6a",
ChargeType: "Monthly",
PurchaseTime: "",
ExpireTime: "",
OrderId: "uuid"},{Id: "xxx",InstanceCount: 3}]}'
输出示例
正常
{
RequestId: "uuid", //任务ID
Status:0 //任务状态成功
}
异常
{
RequestId:"uuid", //任务ID
Status:1, //任务状态失败
ErrorCode: 400, //错误响应。参考通用错误码定义
ErrorMessage: "" //错误响应。如果是同步请求，随请求返回
}
纯净模式