接口功能介绍
扩容实例。
接口约束
- 仅支持对1.1.0及以上版本的实例节点进行扩容。2. 被扩容的实例必须处于运行状态中，且当前不存在运维操作。3. 专属master节点暂不支持扩容。
URI
POST /os/openapi/v1/cluster/extendInstance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterId | 是 | String | 集群ID | Elasticsearch-W6BvE9Ur1Egfd5sGnE | |
| nodeGroupName | 是 | String | 节点组名称: 1.数据节点：MASTER 2.专属master节点：EXCLUSIVE_MASTER 3.专属协调节点：COORDINATE 4.冷数据节点：COLD |
MASTER | |
| increaseHostNum | 是 | Integer | 扩容节点的数量，限制如下： 1.公测期间节点组节点总数不超过公测限制 2.多可用区时，专属协调节点和冷数据节点扩容数量需为当前实例所在多可用数量的整数倍 |
1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，成功：200，失败：500 | 200 | |
| error | String | 错误码，请求成功时，不返回该字段 | OS_400012 | |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | |
| returnObj | Object | 返回结果 | 表 returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| orderNo | String | 订单号 | 20221018153152727265 |
枚举参数
无
请求示例
请求url
https://ctcsx-global.ctapi.ctyun.cn/os/openapi/v1/cluster/extendInstance
请求头header
无
请求体body
{
"clusterId": "Elasticsearch-BFRBNEAKKCOEFKPPQH",
"nodeGroupName": "COORDINATE",
"increaseHostNum": 3
}
响应示例
请求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": {
"orderNo": "20250313161403854557"
}
}
请求失败示例：
{
"statusCode": 500,
"error": "OS_400000",
"message": "请求失败"
}
ak传错示例：
{
"statusCode": "CTAPI_10002",
"returnObj": {
},
"code": "10002",
"message": "ctyun-EOP: Invalid APP ID in request",
"error": "10002",
"requestId": "b0747f9e5ef24a7e95ad9324dbe6d885",
"eopErrCode": "10002"
}
sk传错示例：
{
"statusCode": "CTAPI_10009",
"returnObj": {
},
"code": "10009",
"message": "ctyun-EOP: signature verification failed",
"error": "10009",
"requestId": "ee133410bed24812b8f70cc27299401b",
"eopErrCode": "10009"
}
必传的传空示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"nodeGroupName":"mustnotbeblank"}"
}
请求参数类型不正确示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"increaseHostNum":"must be greater than or equal to 1"}"
}
请求参数值无效示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"clusterId":"无效的实例id"}"
}
错误的实例版本示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"clusterId":"当前实例版本不支持扩容"}"
}
节点组名称错误示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"clusterId":"实例状态非“运行中”无法扩容"}"
}
扩容节点上限示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"increaseNum":"COLD节点组的节点数量上限为“6”，现已开通“6”台，最多还能扩容“0”台"}"
}
实例扩容数量不符合预期示例：
{
"statusCode": 500,
"error": "OS_400034",
"message": "专属master节点数量需要为单数",
"returnObj": {
}
}
专属协调节点|冷数据节点数量需要是可用区数量的整数倍示例：
{
"statusCode": 500,
"error": "OS_400035",
"message": "专属协调节点|冷数据节点数量需要是可用区数量的整数倍",
"returnObj": {
}
}
主机规格已售罄示例：
{
"statusCode": 500,
"error": "OS_400037",
"message": "主机规格已售罄",
"returnObj": {
}
}
状态码
请参考 状态码
错误码
请参考 错误码
