save_client_params_x 保存网管客户端配置参数
POST /api/v1/net_manage/save_client_params_x
描述
保存网管客户端配置参数,用于配置设备与网管的连接参数。用于上报设备信息,上报设备在线状态,上报设备告警信息,上报设备性能信息。 X86平台使用,比CS1588平台多一个network_interface属性。
访问权限
具备以下权限:
net_manage:save_client_params_x
请求参数
请求参数如下:
{
"server_ip": "string",
"server_port": number,
"subnet_name": "string",
"element_name": "string",
"element_alias": "string",
"description": "string",
"network_interface": "string"
}
提示
- server_ip: 网管服务器地址。可以是IP地址或者域名。
- server_port: 网管UDP端口。
- subnet_name: 子网名称。
- element_name: 设备名称。
- element_alias: 设备别名。
- description: 设备描述。
- network_interface: 本地网管接口名称。
响应结果
请求返回的HTTP状态码为200
{
"success": true|false,
"errorCode"?: "option string",
"errorMessage"?: "option string",
"showType"?: 0|1|2|4|9,
"traceId"?: "option string"
}
正确结果示例:
{
"success": true
}
错误结果示例:
{
"success": false,
"errorCode": "string",
"errorMessage": "string"
}
错误码
| 错误码 | 说明 | 错误信息 | 显示类型 |
|---|---|---|---|
| 40007 | 服务器IP不能为空 | server_ip.can.not.be.empty | 4 |
| 40007 | 服务器端口不能为空 | server_port.can.not.be.empty | 4 |
| 40007 | 端口号必须在0-65535之间 | port.must.be.between.0.and.65535 | 4 |
| 40007 | 子网名称不能为空 | subnet_name.can.not.be.empty | 4 |
| 40007 | 子网名称不能超过256个字符 | subnet_name.can.not.be.more.than.256.chars | 4 |
| 40007 | 设备名称不能为空 | element_name.can.not.be.empty | 4 |
| 40007 | 设备名称不能超过256个字符 | element_name.can.not.be.more.than.256.chars | 4 |
| 40007 | 设备别名不能为空 | element_alias.can.not.be.empty | 4 |
| 40007 | 设备别名不能超过256个字符 | element_alias.can.not.be.more.than.256.chars | 4 |
| 40007 | 设备描述不能超过1024个字符 | description.can.not.be.more.than.1024.chars | 4 |
| 40007 | 设备描述不能为空 | description.can.not.be.empty | 4 |
| 40007 | 网管接口名称不能为空 | network_interface.can.not.be.empty | 4 |
| 40007 | 网管接口名称不能超过64个字符 | network_interface.can.not.be.more.than.64.chars | 4 |