跳到主要内容

save_client_monitor_status 保存客户端监控状态

POST /api/v1/ntp/save_client_monitor_status​

描述​

保存客户端监控状态接口，用于设置客户端监控状态信息。

访问权限​

需要登录，具备以下权限：

ntp:save_server_params_v2

JSON参数​

请求参数为JSON格式：

{
  "monitorEnabled": boolean,
  "alarmThreshold": number,
  "maxClients": number,
  "monitorIpList": [
    "ipAddress1",
    "ipAddress2",
    ...
  ]
}
提示
  • monitorEnabled: 必须参数，bool值，表示是否启用客户端监控，默认false
  • alarmThreshold: 可选参数，数字值，表示告警时间阈值（秒），客户端开始同步后超过阈值将会发送一次告警，默认60秒。
  • maxClients: 可选参数，数字值，表示最大监控客户端数量，默认100。
  • monitorIpList: 可选参数，字符串数组，表示需要监控的客户端IP地址列表，支持IPv4和IPv6格式。

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "data"?: { 
    "monitorEnabled": boolean,
    "alarmThreshold": number,
    "maxClients": number,
    "monitorIpList": [
      "ipAddress1",
      "ipAddress2",
      ...
    ]
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

示例​

请求示例：

{
  "monitorEnabled": true,
  "alarmThreshold": 10,
  "maxClients": 80,
  "monitorIpList": [
    "192.168.1.100",
    "::ffff:192.168.1.100",
    "172.16.0.0/12"
  ]
}

正确结果示例：

{
  "success": true
}

错误结果示例：

{
  "success": false,
  "errorCode": "",
  "errorMessage": "",
  "showType": "",
  "traceId": ""
}