此操作用来设置远程协助。

请求语法

PUT /rest/v1/system/config/remoteAccess HTTP/1.1
Date: date
Content-Type: application/json; charset=utf-8
Content-Length: length
Host: ip:port
Authorization: authorization

{
    "serverId": serverId,
    "status": status,
    "host": host,
    "port": port
}

请求参数

名称
描述
是否必须
serverId
服务器ID。
如果不指定，默认设置当前被请求的服务器。
类型：字符串
否
status
是否启用远程协助。
类型：枚举
取值：
Enabled：启用。
Disabled：禁用。
是
host
远程协助的服务端IP或域名。
说明
请联系软件供应商获取host信息。
除下列情况host必填外，其他情况选填：
如果启用远程协助时，此项在服务端没有保存过。
如果设置远程协助时，输入了具体的端口号。
否
port
远程协助的端口。
说明
请联系软件供应商获取端口号。
类型：整型
取值：[1,65535]，默认18100。
否

响应结果

名称
描述
code
远程协助码，6位数字。
host
远程协助的服务端IP。
port
远程协助端口。

请求示例

设置远程协助。

PUT /rest/v1/system/config/remoteAccess HTTP/1.1
Date: Thu, 17 Mar 2022 09: 20: 16 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 113
Host: 192.168.0.121: 1443
Authorization: HBlock userName:signature

{
    "serverId": "hblock_1",
    "status": "Enabled",
    "host": "182.151.21.174",
    "port": 18100
}

响应示例

HTTP/1.1 200 OK 
Date: Thu, 17 Mar 2022 09: 20: 16 GMT
Content-Length: 63
Connection:keep-alive
Content-Type: application/json; charset=utf-8
x-hblock-request-id: a839f9f8e76a4f18969f7e2637c957eb
Server: HBlock

{
    "data": {
        "code": "999342",
        "host": "182.151.21.174",
        "port": 18100
    }
}