跳到主要内容

port_statistics PTP端口统计信息

POST /api/v1/ptp/port_statistics_x​

描述​

获取PTP端口统计信息接口，用于获取PTP端口的统计数据。

访问权限​

具备以下权限：

ptp:status_list

JSON参数​

请求参数如下：

{
  "id": 0~n
}
提示
  • id: PTP端口ID，取值范围为0~n，表示获取指定id的PTP端口统计数据.

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false, 
  "data"?: 
  {
    "portId": number,         // PTP端口ID, 从0开始
    "interfaceName": string, // PTP端口对应的网络接口名称，如："ethi210", "eth_ntp0", "eth_ntp1", "eth_ntp2"
    "rxSync": number,         // PTP端口接收Sync报文计数
    "txSync": number,         // PTP端口发送Sync报文计数
    "rxAnnounce": number,     // PTP端口接收Announce报文计数
    "txAnnounce": number,     // PTP端口发送Announce报文计数
    "rxDelayReq": number,     // 工作在Master模式的端口，并且有下游设备建立的PTP同步，接收下游设备发送的DelayReq计数
    "txDelayReq": number,     // 工作在Slave模式的端口，向上游设备发送DelayReq计数
    "lastUpdate": number      // 最后更新时间戳，单位为秒
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
提示
  • portId: PTP端口ID, 从0开始
  • interfaceName: PTP端口对应的网络接口名称，如："ethi210", "eth_ntp0", "eth_ntp1", "eth_ntp2"
  • rxSync: PTP端口接收Sync报文计数
  • txSync: PTP端口发送Sync报文计数
  • rxAnnounce: PTP端口接收Announce报文计数
  • txAnnounce: PTP端口发送Announce报文计数
  • rxDelayReq: 工作在Master模式的端口，并且有下游设备建立的PTP同步，接收下游设备发送的DelayReq计数
  • txDelayReq: 工作在Slave模式的端口，向上游设备发送DelayReq计数
  • lastUpdate: 最后更新时间戳，单位为秒

正确响应结果示例：

{
  "success": true,
  "data": 
  {
    "portId": 0,
    "interfaceName": "eth_ntp0",
    "rxSync": 100,
    "txSync": 95,
    "rxAnnounce": 50,
    "txAnnounce": 48,
    "rxDelayReq": 30,
    "txDelayReq": 28,
    "lastUpdate": 1700000000 // 最后更新时间戳，单位为秒
  }
}

错误响应结果示例：

{
  "success": false,
  "errorCode": "40004",
  "errorMessage": "ptp.not.found",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40004PTP不存在ptp.not.found4
提示

4 表示错误, 弹出错误提示框