此操作用来批量查询服务器。
请求语法
GET /rest/v1/system/server?filter=filter&serverId=serverId&detail=Boolean&range=i-j HTTP/1.1
Date: date
Host: ip:port
Authorization: authorization请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| filter | String | 查询的过滤条件。 过滤条件由查询属性和属性值组成,其中属性和属性值之间用单个冒号分隔(key:value)表示模糊匹配,用两个冒号分隔(key::value)表示精确匹配。可以选择多个查询,如果是或的关系,使用“or”将查询条件分隔开;如果是与的关系,使用“and”将查询条件分隔开。 支持的查询条件为:
| 否 |
| serverId | String | 服务器ID。 取值:
默认值为all。 说明 可以同时指定多个参数,以逗号隔开,如serverId=hblock_1,hblock_2,default。 | 否 |
| detail | Boolean | 是否展示服务器的详细信息。 取值:
默认值为false。 | 否 |
| range | String | 查询服务器的范围,格式为i-j,i和j为正整数,0 < j-i < 1000。按照服务器ID进行排序,返回第i到第j的服务器。 如果输入的查询范围超过服务器的总个数,返回的结果为空,如果未指定range,则返回所有符合条件的服务器。 | 否 |
响应结果
| 名称 | 类型 | 描述 |
|---|---|---|
| servers | Array of server | 服务器HBlock属性集合,详见“表1 响应参数server说明”。 |
| default | List of default | 集群中后续加入节点的HBlock默认参数集合,详见“表7 响应参数default说明”。 |
表1 响应参数server说明
| 名称 | 类型 | 描述 |
|---|---|---|
| serverName | String | 服务器名称。 |
| serverId | String | 服务器ID。 |
| status | String | 服务器状态:
|
| version | String | 服务器上的HBlock版本。 |
| isMasterServer | Boolean | 该服务器是否为Master节点:
|
| isBaseServer | Boolean | 该服务器是否为基础节点:
|
| publicAddress.ip | String | 业务网络的IP。 |
| publicAddress.port | Integer | 业务网络端口号。 |
| clusterAddress.ip | String | 集群网络的IP。 |
| clusterAddress.port | Integer | 集群网络端口号。 |
| allDiskPaths.usedCapacity | Long | 当前服务器所有HBlock数据目录对应分区的已用容量,单位是bytes。 说明 查询参数detail取值为false时展示。 |
| allDiskPaths.totalCapacity | Long | 当前服务器所有HBlock数据目录对应分区的总容量,单位是bytes。 说明 查询参数detail取值为false时展示。 |
| targetPortalIP.ips | Array of targetPortalIP.ip | iSCSI目标门户IP属性集合,详见“表2 响应参数targetPortalIP.ip说明”。 说明 查询参数detail取值为true时展示。 |
| targetPortalIP.status | String | iSCSI目标门户IP状态:
说明 查询参数detail取值为true时展示。 |
| diskPaths | Array of diskPath | HBlock数据目录信息集合,详见“表3 响应参数diskPath说明”。 说明 查询参数detail取值为true时展示。 |
| defaultPath | String | 默认的数据目录(仅单机版支持)。 |
| recentStartTime | Long | HBlock服务在该节点上最近一次成功启动的时间。 服务器未连接时,不返回此项。 |
| ports | Array of port | HBlock端口的集合,详见“表4 响应参数port说明”。 |
| portRange | String | 端口范围。 |
| iSCSIPort | Integer | iSCSI端口。 |
| storagePorts | Array of storagePort | 存储服务端口集合(仅集群版支持),详见“表5 响应参数storagePort说明”。 |
| nodeName | String | 节点名称(仅集群版支持)。 |
| parentName | String | 父节点名称(仅集群版支持)。 |
| description | String | 节点描述(仅集群版支持)。 |
| baseServices | Array of baseService | 基础服务属性的集合(仅集群版基础服务器支持),详见“表6 响应参数baseService说明”。 |
| maxMemoryRatio | Double | HBlock可使用的内存占用系统总内存的比例上限。 |
| maxMemorySize | Long | HBlock可使用的内存的最大值,单位是bytes。 |
表2 响应参数targetPortalIP.ip说明
| 名称 | 类型 | 描述 |
|---|---|---|
| ip | String | iSCSI目标门户IP。 |
| port | Integer | iSCSI目标门户端口号。 |
表3 响应参数diskPath说明
| 名称 | 类型 | 描述 |
|---|---|---|
| path | String | HBlock数据目录。 |
| storagePool | String | 数据目录所属存储池(仅集群版支持)。 |
| totalCapacity | Long | 当前HBlock数据目录对应分区的总容量,单位是bytes。 |
| usedCapacity | Long | 服务器上HBlock数据目录对应分区的已用容量,单位是bytes。 |
| usedCapacityQuota | Long | HBlock在该数据目录的已写入量,即已用容量配额。单位是bytes。 |
| capacityQuota | Long | 数据目录的容量配额。单位是bytes。 0表示禁止写入。不输出,表示没有限制。 |
| managementStatus | String | 数据目录管理状态:
|
| subStatus.stage | String | 移除数据目录所处的阶段:
|
| subStatus.totalFD | Integer | 总的故障域个数。 |
| subStatus.healthyFD | Integer | 状态为Healthy的故障域个数。 |
| subStatus.warningFD | Integer | 状态为Warning的故障域个数。 |
| subStatus.errorFD | Integer | 状态为Error的故障域个数。 |
| subStatus.safeData | Double | 安全数据百分比,单位是%。 |
| subStatus.reconstructionWaitData | Double | 需要重建的数据百分比,单位是%。 |
| subStatus.availFDWaitData | Double | 移除磁盘或者服务器时,数据重建需要的故障域个数不足,因此引发的无法重建的数据百分比。 |
| subStatus.singleCopyLUNData | Double | 单副本数据百分比,单位是%。 |
| subStatus.corruptedData | Double | 已经损坏的数据百分比,单位是%。 |
| subStatus.availFDWaitWarning | String | 告警信息。 根据状态不同,显示的告警信息不同:
|
| subStatus.singleCopyLUNWarning | String | |
| subStatus.corruptedWarning | String | |
| healthStatus | String | 数据目录健康状态:
|
| healthDetail | Array of string | 数据目录健康状态详情:
|
| dsId | String | 数据目录对应的ds进程(仅集群版支持)。 说明 数据目录加入存储池后才会展示ds进程。 |
表4 响应参数port说明
| 名称 | 类型 | 描述 |
|---|---|---|
| portName | String | HBlock端口名称。 |
| port | Integer | HBlock在当前服务器上使用的端口号。 |
表5 响应参数storagePort说明
| 名称 | 类型 | 描述 |
|---|---|---|
| portN | Integer | 存储服务端口。 |
| diskpath | String | 存储服务的数据目录。 |
| pathId | Integer | 数据目录ID。 |
表6 响应参数baseService说明
| 名称 | 类型 | 描述 |
|---|---|---|
| name | String | 基础服务名称:
|
| status | String | 基础服务的状态:
|
| metaDir | String | 存储基础服务数据的数据目录。 |
表7 响应参数default说明
| 名称 | 类型 | 描述 |
|---|---|---|
| portRange | String | 后续加入集群节点的端口范围。 |
| maxMemoryRatio | Double | 后续加入集群节点的HBlock可使用的内存占用系统总内存的比例上限。 |
| maxMemorySize | Long | 后续加入集群节点的HBlock可使用的内存的最大值,单位是bytes。 |
请求示例1
单机版:查询服务器的详细信息。
GET /rest/v1/system/server?detail=true HTTP/1.1
Date: Fri, 09 Jan 2026 07:55:19 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.66:1443响应示例1
HTTP/1.1 200 OK
Date: Fri, 09 Jan 2026 07:55:19 GMT
x-hblock-request-id: a779ec83337e4fee814f10cc2955e976
Connection: keep-alive
Content-Length: 941
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"servers": [
{
"serverName": "songt-005",
"serverId": "hblock_1",
"status": "Connected",
"version": "4.0.0",
"publicAddress": {
"ip": "192.168.0.66",
"port": 3260
},
"clusterAddress": {
"ip": "192.168.0.66",
"port": 20001
},
"targetPortalIP": {
"ips": [
{
"ip": "10.1.0.1",
"port": 101
}
],
"status": "Disabled"
},
"diskPaths": [
{
"path": "/mnt/stor01",
"usedCapacity": 2528911360,
"totalCapacity": 100169342976,
"usedCapacityQuota": 1097037922,
"managementStatus": "Added",
"healthStatus": "Healthy",
"healthDetail": []
}
],
"defaultPath": "/mnt/stor01",
"recentStartTime": 1767919098886,
"ports": [
{
"portName": "apiPort",
"port": 1443
},
{
"portName": "webPort",
"port": 2443
},
{
"portName": "managementPort1",
"port": 20001
},
{
"portName": "managementPort2",
"port": 20003
},
{
"portName": "managementPort3",
"port": 20000
},
{
"portName": "managementPort4",
"port": 20004
},
{
"portName": "managementPort6",
"port": 20002
}
],
"portRange": "19500-21500",
"iSCSIPort": 3260,
"maxMemoryRatio": 0.8,
"maxMemorySize": 9223372036854775807
}
]
}
}请求示例2
集群版:查询第2和第3个服务器。
GET /rest/v1/system/server?range=2-3 HTTP/1.1
Date: Sun, 04 Jan 2026 05:39:36 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.65:1443响应示例2
HTTP/1.1 200 OK
Date: Sun, 04 Jan 2026 05:39:36 GMT
x-hblock-request-id: 35482534f144466fb71a88c585796879
Connection: keep-alive
Content-Length: 3302
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"servers": [
{
"serverName": "k8s-master",
"serverId": "hblock_2",
"status": "Connected",
"version": "4.0.0",
"isMasterServer": false,
"isBaseServer": true,
"publicAddress": {
"ip": "192.168.0.64",
"port": 3260
},
"clusterAddress": {
"ip": "192.168.0.64",
"port": 20015
},
"allDiskPaths": {
"usedCapacity": 19339370496,
"totalCapacity": 142631432192
},
"recentStartTime": 1767489601645,
"ports": [
{
"portName": "apiPort",
"port": 1443
},
{
"portName": "webPort",
"port": 2443
},
{
"portName": "managementPort1",
"port": 20015
},
{
"portName": "managementPort2",
"port": 20013
},
{
"portName": "managementPort3",
"port": 20016
},
{
"portName": "managementPort4",
"port": 20000
},
{
"portName": "managementPort5",
"port": 20003
},
{
"portName": "managementPort6",
"port": 20010
},
{
"portName": "managementPort7",
"port": 20014
},
{
"portName": "dataPort1",
"port": 20007
},
{
"portName": "metadataPort1",
"port": 20011
},
{
"portName": "metadataPort2",
"port": 20004
},
{
"portName": "metadataPort3",
"port": 20005
},
{
"portName": "metadataPort4",
"port": 20009
},
{
"portName": "metadataPort5",
"port": 20006
},
{
"portName": "metadataPort6",
"port": 20008
},
{
"portName": "metadataPort7",
"port": 20002
},
{
"portName": "metadataPort8",
"port": 20001
},
{
"portName": "metadataPort9",
"port": 20012
}
],
"portRange": "20000-20500",
"iSCSIPort": 3260,
"storagePorts": [
{
"port1": 20017,
"port2": 20019,
"port3": 20018,
"diskpath": "/mnt/stor02",
"pathId": "1"
},
{
"port1": 20020,
"port2": 20022,
"port3": 20021,
"diskpath": "/mnt/stor01",
"pathId": "2"
}
],
"nodeName": "default:hblock_2",
"parentName": "default",
"baseServices": [
{
"name": "mdm",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
},
{
"name": "ls",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
},
{
"name": "cs",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
}
],
"maxMemoryRatio": 0.9,
"maxMemorySize": 9223372036854775807
},
{
"serverName": "songt-0006",
"serverId": "hblock_3",
"status": "Connected",
"version": "4.0.0",
"isMasterServer": false,
"isBaseServer": true,
"publicAddress": {
"ip": "192.168.0.67",
"port": 3260
},
"clusterAddress": {
"ip": "192.168.0.67",
"port": 20015
},
"allDiskPaths": {
"usedCapacity": 1816420352,
"totalCapacity": 199407550464
},
"recentStartTime": 1767489617411,
"ports": [
{
"portName": "apiPort",
"port": 1443
},
{
"portName": "webPort",
"port": 2443
},
{
"portName": "managementPort1",
"port": 20015
},
{
"portName": "managementPort2",
"port": 20013
},
{
"portName": "managementPort3",
"port": 20016
},
{
"portName": "managementPort4",
"port": 20000
},
{
"portName": "managementPort5",
"port": 20003
},
{
"portName": "managementPort6",
"port": 20010
},
{
"portName": "managementPort7",
"port": 20014
},
{
"portName": "dataPort1",
"port": 20007
},
{
"portName": "metadataPort4",
"port": 20009
},
{
"portName": "metadataPort5",
"port": 20006
},
{
"portName": "metadataPort6",
"port": 20008
},
{
"portName": "metadataPort7",
"port": 20002
},
{
"portName": "metadataPort8",
"port": 20001
},
{
"portName": "metadataPort9",
"port": 20012
}
],
"portRange": "20000-20500",
"iSCSIPort": 3260,
"storagePorts": [
{
"port1": 20004,
"port2": 20011,
"port3": 20005,
"diskpath": "/mnt/stor01",
"pathId": "1"
},
{
"port1": 20017,
"port2": 20019,
"port3": 20018,
"diskpath": "/mnt/stor02",
"pathId": "2"
}
],
"nodeName": "default:hblock_3",
"parentName": "default",
"baseServices": [
{
"name": "ls",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
},
{
"name": "cs",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
}
],
"maxMemoryRatio": 0.9,
"maxMemorySize": 9223372036854775807
}
]
}
} 请求示例3
集群版:查询hblock_1、hblock_2服务器详细信息及后续加入节点的默认信息。
GET /rest/v1/system/server?serverId=hblock_1,hblock_2,default&detail=true HTTP/1.1
Date: Thu, 05 Mar 2026 01:21:11 GMT
Authorization: HBlock userName:signature
Host: 192.168.0.65:1443响应示例3
HTTP/1.1 200 OK
Date: Thu, 05 Mar 2026 01:21:11 GMT
x-hblock-request-id: 0894b4c100524575ad220028f046d8ce
Connection: keep-alive
Content-Length: 3836
Content-Type: application/json;charset=utf-8
Server: HBlock
"data": {
"servers": [
{
"serverName": "songt-0004",
"serverId": "hblock_1",
"status": "Connected",
"version": "4.0.0",
"isMasterServer": true,
"isBaseServer": true,
"publicAddress": {
"ip": "192.168.0.65",
"port": 3260
},
"clusterAddress": {
"ip": "192.168.0.65",
"port": 20005
},
"targetPortalIP": {
"ips": [
{
"ip": "10.0.0.3",
"port": 3261
}
],
"status": "Enabled"
},
"diskPaths": [
{
"path": "/mnt/stor01",
"storagePool": "default",
"usedCapacity": 43635916800,
"totalCapacity": 99703775232,
"usedCapacityQuota": 43619094956,
"managementStatus": "Added",
"healthStatus": "Healthy",
"healthDetail": [],
"dsId": "ds-1"
}
],
"recentStartTime": 1772608577246,
"ports": [
{
"portName": "apiPort",
"port": 1443
},
{
"portName": "webPort",
"port": 2443
},
{
"portName": "managementPort1",
"port": 20005
},
{
"portName": "managementPort2",
"port": 20013
},
{
"portName": "managementPort3",
"port": 20002
},
{
"portName": "managementPort4",
"port": 20016
},
{
"portName": "managementPort5",
"port": 20003
},
{
"portName": "managementPort6",
"port": 20006
},
{
"portName": "managementPort7",
"port": 20007
},
{
"portName": "dataPort1",
"port": 20014
},
{
"portName": "metadataPort1",
"port": 20008
},
{
"portName": "metadataPort2",
"port": 20004
},
{
"portName": "metadataPort3",
"port": 20011
},
{
"portName": "metadataPort4",
"port": 20012
},
{
"portName": "metadataPort5",
"port": 20000
},
{
"portName": "metadataPort6",
"port": 20015
},
{
"portName": "metadataPort7",
"port": 20009
},
{
"portName": "metadataPort8",
"port": 20001
},
{
"portName": "metadataPort9",
"port": 20010
}
],
"portRange": "20000-20500",
"iSCSIPort": 3260,
"storagePorts": [
{
"port1": 20017,
"port2": 20019,
"port3": 20018,
"diskpath": "/mnt/stor01",
"pathId": "1"
}
],
"nodeName": "default:hblock_1",
"parentName": "default",
"baseServices": [
{
"name": "mdm",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
},
{
"name": "ls",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
},
{
"name": "cs",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
}
],
"maxMemoryRatio": 0.95,
"maxMemorySize": 9223372036854775807
},
{
"serverName": "k8s-master",
"serverId": "hblock_2",
"status": "Connected",
"version": "4.0.0",
"isMasterServer": false,
"isBaseServer": true,
"publicAddress": {
"ip": "192.168.0.64",
"port": 3260
},
"clusterAddress": {
"ip": "192.168.0.64",
"port": 20005
},
"diskPaths": [
{
"path": "/mnt/stor02",
"storagePool": "default",
"usedCapacity": 43636088832,
"totalCapacity": 99703775232,
"usedCapacityQuota": 43636043776,
"managementStatus": "Added",
"healthStatus": "Healthy",
"healthDetail": [],
"dsId": "ds-1"
}
],
"recentStartTime": 1772614410202,
"ports": [
{
"portName": "apiPort",
"port": 1443
},
{
"portName": "webPort",
"port": 2443
},
{
"portName": "managementPort1",
"port": 20005
},
{
"portName": "managementPort2",
"port": 20013
},
{
"portName": "managementPort3",
"port": 20002
},
{
"portName": "managementPort4",
"port": 20016
},
{
"portName": "managementPort5",
"port": 20003
},
{
"portName": "managementPort6",
"port": 20006
},
{
"portName": "managementPort7",
"port": 20007
},
{
"portName": "dataPort1",
"port": 20014
},
{
"portName": "metadataPort1",
"port": 20008
},
{
"portName": "metadataPort2",
"port": 20004
},
{
"portName": "metadataPort3",
"port": 20011
},
{
"portName": "metadataPort4",
"port": 20012
},
{
"portName": "metadataPort5",
"port": 20000
},
{
"portName": "metadataPort6",
"port": 20015
},
{
"portName": "metadataPort7",
"port": 20009
},
{
"portName": "metadataPort8",
"port": 20001
},
{
"portName": "metadataPort9",
"port": 20010
}
],
"portRange": "20000-20500",
"iSCSIPort": 3260,
"storagePorts": [
{
"port1": 20017,
"port2": 20019,
"port3": 20018,
"diskpath": "/mnt/stor02",
"pathId": "1"
}
],
"nodeName": "default:hblock_2",
"parentName": "default",
"baseServices": [
{
"name": "mdm",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
},
{
"name": "ls",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
},
{
"name": "cs",
"status": "Up",
"metaDir": "/mnt/storage01/CTYUN_HBlock_Plus_4.0.0_x64"
}
],
"maxMemoryRatio": 0.95,
"maxMemorySize": 9223372036854775807
}
],
"default": {
"portRange": "20000-20500",
"maxMemoryRatio": 0.9,
"maxMemorySize": 9223372036854775807
}
}
}