重启
更新时间 2025-11-24 18:23:07
最近更新时间: 2025-11-24 18:23:07
接口功能介绍
该接口提供实例全量重启、滚动重启的功能。
接口约束
1.0.0、1.1.0版本的实例只支持对实例进行全量重启
URI
POST /os/openapi/v1/cluster/restart
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterId | 是 | String | 实例id | Elasticsearch-AIRODJOGJMPCDAREFE | |
| restartType | 是 | Integer | 重启对象，logstash实例只支持实例重启； 1：实例重启 2：角色重启 3：节点重启 | 1 | |
| operateType | 是 | String | 重启类型； RESTART_COMPONENT：全量重启 ROLLING_RESTART_INSTANCE：滚动重启 | RESTART_COMPONENT | |
| restartRole | 否 | Array of Strings | restartType值为2时，该参数必填。 COORDINATE：专属协调节点 COLD：冷数据节点 MASTER：数据节点 EXCLUSIVE_MASTER：专属master节点 | ["MASTER"] | |
| hostInfo | 否 | Object | restartType值为3时，该参数必填。 | hostInfo | |
| 表 hostInfo |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| hostIp | 是 | String | 重启节点的ipv4地址 | 192.168.0.1 | |
| type | 是 | String | 重启节点的类型 COORDINATE：专属协调节点 COLD：冷数据节点 MASTER：数据节点 EXCLUSIVE_MASTER：专属master节点 ROUTER：图形化访问节点中的kibana或dashboards服务 ROUTER_CEREBRO：图形化访问节点中的cerebro服务 | COLD |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，成功：200，失败：500 | 200 | |
| error | String | 错误码，请求成功时，不返回该字段 | OS_400000 | |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | |
| returnObj | Object | 返回结果 | 表 returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Boolean | true:请求提交成功 | true |
枚举参数
无
请求示例
请求url
https://ctcsx-global.ctapi.ctyun.cn/os/openapi/v1/cluster/restart
请求头header
无
请求体body
{
"clusterId": "Elasticsearch-AIRODJOGJMPCDAREFE",
"operateType": "ROLLING_RESTART_INSTANCE",
"restartType": 3,
"restartRole": [
"MASTER",
"EXCLUSIVE_MASTER"
],
"hostInfo": {
"hostIp": "192.168.3.10",
type: "ROUTER"
}
}
响应示例
请求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": {
"result": true
}
}
请求失败示例：
{
"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": "{\"hostIp\":\"值不合法，节点重启时该参数必填，且必须是ip格式\"}"
}
状态码
请参考 状态码
错误码
请参考 错误码
