Skip to main content

get_client_monitor_status 获取客户端监控状态

POST /api/v1/ntp/get_client_monitor_status​

描述​

获取客户端监控状态接口，用于获取客户端监控状态信息。

访问权限​

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

ntp:get_server_params_v2

JSON参数​

请求参数为JSON格式：

{}

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false,
  "data"?: { 
    "monitorEnabled": boolean,
    "alarmThreshold": number,
    "maxClients": number,
    "monitorIpList": string[]
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
tip
  • monitorEnabled: 客户端监控是否启用，true表示启用，false表示未启用。必须参数。
  • alarmThreshold: 告警阈值，单位为秒。当客户端超过该阈值未同步时触发告警。可选参数，默认值为60秒。
  • maxClients: 最大监控客户端数量。可选参数，取值范围为1到4096，默认值为100。
  • monitorIpList: 监控的客户端IP地址列表。 支持IPv4和IPv6地址，既可以是单个IP地址，也可以是CIDR格式。可选参数，默认值为空，表示不限制IP地址，监控最多maxClients个客户端。

示例​

请求示例：

{}

正确结果示例：

{
  "success": true,
  "data": {
    "monitorEnabled": true,
    "alarmThreshold": 10,
    "maxClients": 80,
    "monitorIpList": [
      "192.168.1.100",
      "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "10.0.0.0/8"
    ]
  }
}

错误结果示例：

{
  "success": false,
  "errorCode": "ntp.monitor.not.enabled",
  "errorMessage": "NTP客户端监控未启用",
  "showType": 1,
  "traceId": "abcd1234efgh5678"
}