接口功能介紹
擴容實例。
接口約束
- 僅支持對1.1.0及以上版本的實例節點進行擴容
2. 被擴容的實例必須處于運行狀態中，且當前不存在運維操作
3. 專屬master節點暫不支持擴容
4. 該接口暫不支持對Logstash實例進行擴容
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
//ctcsx-global.ctapi.daliqc.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": {
}
}
狀態碼
請參考
錯誤碼
請參考
