跳到主要内容

get_client_params_x 获取客户端参数

POST /api/v1/net_manage/get_client_params_x​

描述​

获取网管客户端配置参数，用于配置设备与网管的连接参数。用于上报设备信息，上报设备在线状态，上报设备告警信息，上报设备性能信息。 X86平台使用，比CS1588平台多一个network_interface属性。

访问权限​

具备以下权限：

net_manage:get_client_params_x

请求参数​

请求参数如下：

{}

无参数，必须传递空对象。

请求示例：

{}

响应结果​

请求返回的HTTP状态码为200

{
  "success": true|false,
  "data"?: {
    "server_ip": "string",
    "server_port": number,
    "subnet_name": "string",
    "element_name": "string",
    "element_alias": "string",
    "description": "string",
    "network_interface": "string"
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
提示
  • server_ip: 网管服务器地址。可以是IP地址或者域名。
  • server_port: 网管UDP端口。
  • subnet_name: 子网名称。
  • element_name: 设备名称。
  • element_alias: 设备别名。
  • description: 设备描述。
  • network_interface: 本地网管接口名称。

正确结果示例：

{
  "success": true,
  "data": {
    "server_ip": "nms.coolshark.com",
    "server_port": 8161,
    "subnet_name": "海淀区",
    "element_name": "设备1",
    "element_alias": "设备1",
    "description": "设备1",
    "network_interface": "eth_ntp5"
  }
}

错误结果示例：

{
  "success": false,
  "errorCode": "40004",
  "errorMessage": "error.get.config",
  "showType": 4
}