跳到主要内容

slave_sync_info 获取PTP从端同步信息

POST /api/v1/ptp/slave_sync_info_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开始
    "portNumber": number,     // PTP端口号， 从1开始
    "syncState": "UNKNOWN" | "NEVER" | "LOST" | "ACQUIRING" | "ACQUIRED" | "STABLE", // 同步状态
    "offsetFromMaster": number, // 与主时钟的偏差，单位为纳秒
    "meanPathDelay": number, // 平均路径延迟，单位为纳秒
    "masterOffset": number, // 主时钟偏差，单位为纳秒
    "stepsRemoved": number, // 从GM的步数，表示从当前端口到主时钟的距离
    "cumulativeRateOffset": number, // 累计速率偏移，单位为ppm
    "gmPresent": boolean, // GM是否存在
    "gmIdentity": string, // GM标识符，如 "fcaf6a.fffe.02e201"
    "parentPortIdentity": string, // 父端口标识符，如 "18e204.fffe.f005ce-1"
    "gmClockClass": number, // GM时钟等级，取值范围为0~255
    "gmClockAccuracy": number, // GM时钟精度，单位为纳秒
    "gmOffsetScaledLogVariance": number, // GM偏移对数方差
    "gmPriority1": number, // GM优先级1，取值范围为0~255
    "gmPriority2": number, // GM优先级2，取值范围为0~255
    "lastUpdate": number // 最后更新时间戳，单位为秒
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
提示
  • portId: PTP端口ID, 从0开始
  • portNumber: PTP端口号， 从1开始
  • syncState: 同步状态，可能的值包括：
    • UNKNOWN: 未知状态
    • NEVER: 从未同步
    • LOST: 同步丢失
    • ACQUIRING: 正在获取同步
    • ACQUIRED: 已获取同步
    • STABLE: 稳定同步状态
  • offsetFromMaster: 与主时钟的偏差，单位为纳秒
  • meanPathDelay: 平均路径延迟，单位为纳秒
  • masterOffset: 主时钟偏差，单位为纳秒
  • stepsRemoved: 从GM的步数，表示从当前端口到主时钟的距离
  • cumulativeRateOffset: 累计速率偏移，单位为ppm
  • gmPresent: GM是否存在
  • gmIdentity: GM标识符，如 "fcaf6a.fffe.02e201"
  • parentPortIdentity: 父端口标识符，如 "18e204.fffe.f005ce-1"
  • gmClockClass: GM时钟等级，取值范围为0~255
  • gmClockAccuracy: GM时钟精度，单位为纳秒
  • gmOffsetScaledLogVariance: GM偏移对数方差
  • gmPriority1: GM优先级1，取值范围为0~255
  • gmPriority2: GM优先级2，取值范围为0~255
  • lastUpdate: 最后更新时间戳，单位为秒

正确响应结果示例：

{
  "success": true,
  "data": 
  {
    "portId": 0,
    "portNumber": 1,
    "syncState": "ACQUIRED",
    "offsetFromMaster": 123456,
    "meanPathDelay": 1000,
    "masterOffset": 500,
    "stepsRemoved": 1,
    "cumulativeRateOffset": 10,
    "gmPresent": true,
    "gmIdentity": "fcaf6a.fffe.02e201",
    "parentPortIdentity": "18e204.fffe.f005ce-1",
    "gmClockClass": 6,
    "gmClockAccuracy": 50,
    "gmOffsetScaledLogVariance": 0.1,
    "gmPriority1": 128,
    "gmPriority2": 128,
    "lastUpdate": 1700000000
  }
}

错误响应结果示例：

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

错误码​

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

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