查詢遠程協助
更新時間 2025-04-23 15:02:34
最近更新時間: 2025-04-23 15:02:34
分享文章
本節主要介紹如何使用API查詢遠程協助。
此操作用來查詢服務器的遠程協助配置信息。
注意
- 如果HBlock還沒有初始化，那么只顯示本機的信息。
- 僅支持查詢有遠程協助配置的服務器。
請求語法
GET /rest/v1/system/config/remoteAccess?filter=filter&range=i-j HTTP/1.1
Date: date
Host: ip:port
Authorization: authorization請求參數
| 參數 | 類型 | 描述 | 是否必須 |
|---|---|---|---|
| filter | String | 查詢的過濾條件。 支持的查詢條件為：serverId（服務器ID）。 | 否 |
| range | String | 查詢服務器的范圍，格式為i-j，i和j為正整數，0 < j-i < 1000。按照服務器ID進行排序，返回第i到第j的服務器。 如果輸入的查詢范圍超過服務器的總個數，返回的結果為空，如果未指定range，則返回所有符合條件的服務器。 | 否 |
響應結果
| 名稱 | 類型 | 描述 |
|---|---|---|
| serverId | String | 服務器ID，若還沒有初始化，則不顯示此項。 |
| status | String | 遠程協助是否啟用。
|
| host | String | 遠程協助的服務器Host。 |
| port | Integer | 遠程協助的端口。 |
| code | String | 遠程協助碼。 |
請求示例
查詢遠程協助。
GET /rest/v1/system/config/remoteAccess HTTP/1.1
Date: Thu, 17 Mar 2022 09:34:04 GMT
Host: 192.168.0.121:1443
Authorization: HBlock userName:signature響應示例
HTTP/1.1 200 OK
Date: Thu, 17 Mar 2022 09:34:04 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 214
Connection: keep-alive
x-hblock-request-id: 0cda25588df44123ae5113876bd91ca0
Server: HBlock
{
"data": {
"servers": [
{
"serverId": "hblock_1",
"status": "Enabled",
"host": "182.151.21.174",
"port": 18100,
"code": "999342"
},
{
"serverId": "hblock_2",
"status": "Enabled",
"host": "182.151.21.174",
"port": 18100,
"code": "258699"
}
]
}
}
