根据名称查询节点详情
此接口用于根据节点名称查询节点的详细信息。
接口描述
通信协议:HTTP
URL:GET /api/v1/node/name/:name
传参方式:path
请求参数
字段名 | 类型 | 是否必填 | 说明 |
---|---|---|---|
name | string | 是 | 节点名称 |
响应参数
如果查不到,则 data 字段为 null
字段名 | 类型 | 说明 |
---|---|---|
id | string | 节点 ID |
ip | string | 节点地址 |
port | string | 节点端口 |
name | string | 节点名称 |
tls | boolean | 是否使用 TLS 加密 |
type | string | 节点系统类型 |
arch | string | 节点架构 |
password | string | 节点的连接密码 |
createdTime | string | 节点创建时间,格式为 yyyy-MM-dd HH:mm:ss |
请求示例
curl --location --request GET 'http://localhost:3001/api/v1/node/name/192.168.1.1'
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"id": "c8815688-5a49-49ef-963e-a103e9b07b6e",
"name": "192.168.XX.XX",
"ip": "192.168.XX.XX",
"port": 1112,
"type": "sylixos",
"arch": "x86-64",
"createdTime": "2023-03-21 18:47:17",
"tls": 0,
"password": "auth"
}
}
错误码
具体请参见 错误码说明。