此操作用来修改服务器属性。
说明后续新增的数据服务端口会从修改后的端口范围中选择,已使用的端口值不变。
注意修改端口范围(portRange)时,请避免和Linux系统的本地临时端口(ip_local_port_range)范围重合,否则可能会导致HBlock服务所用的端口被占用。使用命令行cat /proc/sys/net/ipv4/ip_local_port_range可以查看本地临时端口范围。
请求语法
PUT /rest/v1/system/server/serverId HTTP/1.1
Date:date
Content-Type: application/json; charset=utf-8
Content-Length: length
Host: ip:port
Authorization:authorization
{
"targetPortalIP": {
"ips": [
{
"ip": ip,
"port": port,
}
],
"status": status
},
"defaultPath": defaultPath,
"portRange": port1-port2
}
请求参数
参数 描述 是否必须 serverId 要修改的服务器ID。
类型:字符串
是 targetPortalIP.ips iSCSI目标门户IP属性集合,包含:ip、port。
类型:数组
说明若服务器与客户端不在同一网段(如服务器位于内网,客户端位于外网),通过NAT设备(如路由器)进行连接,则需要将NAT设备的外网地址和端口添加到服务器,从而使得外网的客户端可以正常与该服务器的Target建立iSCSI连接。
否 ip iSCSI目标门户IP。
说明ip和port必须同时存在,或者同时不存在。
否 port iSCSI目标门户端口号。
说明ip和port必须同时存在,或者同时不存在。
类型:整型
取值:[1, 65535]。
否 targetPortalIP.status 是否启用iSCSI目标门户IP。
类型:枚举
取值:
Enabled:启用。
Disabled:禁用。
是 defaultPath 设置默认的数据目录(仅单机版本支持)。
数据目录必须是已经添加到HBlock系统中,并且状态为Normal的数据目录。
否 portRange 指定端口范围,用于相关服务。
取值:整型,取值范围为[1, 65535],port1为端口范围最小值,port2为端口范围最大值,且port1 < port2。
说明建议指定的端口范围至少包含500个端口。
否
请求示例1
单机版:修改服务器hblock_1的iSCSI目标门户IP和端口修改为:10.1.0.1和101,设置默认数据目录为:/mnt/storage01。
PUT /rest/v1/system/server/hblock_1 HTTP/1.1
Date: Fri, 29 Jul 2022 09:12:25 GMT
Content-Type: application/json; charset=utf-8
Authorization: HBlock userName:signature
Content-Length: 270
Host: 192.168.0.69:1443
{
"targetPortalIP": {
"ips":[
{
"ip":"10.1.0.1",
"port":"101"
}
],
"status":"Enabled"
},
"defaultPath":"/mnt/storage01"
}
响应示例1
HTTP/1.1 204 No Content
x-hblock-request-id: facb844a44034035bd9254c7d901cfac
Connection: keep-alive
Date: Fri, 29 Jul 2022 09:12:25 GMT
Server: HBlock
请求示例2
集群版:修改服务器hblock_1的iSCSI目标门户IP和端口修改为:10.1.0.1和101。
PUT /rest/v1/system/server/hblock_1 HTTP/1.1
Date: Fri, 29 Jul 2022 09:00:33 GMT
Content-Type: application/json; charset=utf-8
Authorization: HBlock userName:signature
Content-Length: 221
Host: 192.168.0.121:1443
{
"targetPortalIP": {
"ips":[
{
"ip":"10.1.0.1",
"port":"101"
}
],
"status":"Enabled"
}
}
响应示例2
HTTP/1.1 204 No Content
x-hblock-request-id: cbe33ebab9ad46df9fe691b71585e230
Connection: keep-alive
Date: Fri, 29 Jul 2022 09:00:33 GMT
Server: HBlock
请求示例3
修改服务器hblock_1的端口范围为19500-20500。
PUT /rest/v1/system/server/hblock_1 HTTP/1.1
Date: Tue, 26 Sep 2023 06:45:38 GMT
Content-Type: application/json; charset=utf-8
Authorization: HBlock userName:signature
Content-Length: 39
Host: 192.168.0.121:1443
{
"portRange":"19500-20500"
}
响应示例3
HTTP/1.1 204 No Content
x-hblock-request-id: 2271ef7c175c44cca2e197c12f2cb742
Connection: keep-alive
Date: Tue, 26 Sep 2023 06:45:38 GMT
Server: HBlock