批量停止服务器上的HBlock服务
更新时间 2026-08-17 09:47:46
最近更新时间: 2026-08-17 09:47:46
本节主要介绍如何使用API批量停止服务器上的HBlock服务。
此操作用来批量停止服务器上的HBlock服务。
前提条件:集群正常工作,所有基础服务正常,并且目标服务器的管理服务(ms)正常。
请求语法
PUT /rest/v1/system/service HTTP/1.1
Date:date
Content-Type: application/json; charset=utf-8
Content-Length: length
Host: ip:port
Authorization:authorization
{
"action": "stop",
"serverIds": [
serverId1,
serverId2,
…,
serverIdN
],
"scope": [
service1,
service2,
…,
serviceN
],
"force": force
}请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| action | String | 停止服务器上的HBlock服务。 取值:stop。 | 是 |
| serverIds | Array of string | 需要停止HBlock服务的服务器。 取值:
注意 同时停止多个服务器上的服务时,仅支持停止以下服务:ps、ms、ag、ua、web、ws。 | 是 |
| scope | Array of string | 停止的HBlock服务范围。 取值:
说明 各服务具体作用详见HBlock服务。 | 否 |
| force | Boolean | 是否强制停止服务上的HBlock服务。 注意 当停止服务器上的HBlock失败时,可以强制停止HBlock服务,但可能会造成数据丢失。 取值:
默认值为false。 | 否 |
响应结果
| 名称 | 类型 | 描述 |
|---|---|---|
| success | Array of success | 停止成功的HBlock服务信息,详见“表1 响应参数success说明”。 |
| failed | Array of failed | 停止失败的HBlock服务信息,详见“表2 响应参数failed说明”。 |
| processing | Array of processing | 停止操作未完成的HBlock服务信息,详见“表3 响应参数processing说明”。 |
表1 响应参数success说明
| 名称 | 类型 | 描述 |
|---|---|---|
| serverId | String | HBlock服务停止成功的服务器。 |
| service | Array of string | 停止成功的HBlock服务。 |
表2 响应参数failed说明
| 名称 | 类型 | 描述 |
|---|---|---|
| serverId | String | HBlock服务停止失败的服务器。 |
| service | Array of string | 停止失败的HBlock服务。 |
| reason | String | HBlock服务停止失败的原因。 |
表3 响应参数processing说明
| 名称 | 类型 | 描述 |
|---|---|---|
| serverId | String | HBlock服务停止操作未完成的服务器。 |
| service | Array of string | 停止操作未完成的HBlock服务。 |
请求示例
停止hblock_2、hblock_3上的HBlock ws和web服务。
PUT /rest/v1/system/service HTTP/1.1
Date: Fri, 17 Jul 2026 08:58:44 GMT
Content-Type: application/json; charset=utf-8
Authorization: HBlock userName:signature
Content-Length: 149
Host: 192.168.0.65:1443
{
"action": "stop",
"serverIds": [
"hblock_2",
"hblock_3"
],
"scope": [
"ws",
"web"
]
}响应示例
HTTP/1.1 200 OK
x-hblock-request-id: 05a7469957104cb2b936d99caea03a84
Connection: keep-alive
Content-Length: 188
Date: Fri, 17 Jul 2026 08:58:46 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"success": [
{
"serverId": "hblock_2",
"service": [
"ws"
]
},
{
"serverId": "hblock_2",
"service": [
"web"
]
},
{
"serverId": "hblock_3",
"service": [
"ws"
]
},
{
"serverId": "hblock_3",
"service": [
"web"
]
}
]
}
}