跳到主要内容

status_list 获取PTP状态列表

POST /api/v1/ptp/status_list_x​

描述​

获取PTP状态接口，用于获取PTP状态信息。在首页显示PTP状态信息。

PTP 状态按照IEEE1588-2008标准定义，包括：INITIALIZING, LISTENING， DISABLED, FAULTY, LISTENING, UNCALIBRATED, SLAVE, MASTER

访问权限​

具备以下权限：

ptp:status_list

JSON参数​

请求参数如下：

{}

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false, 
  "data"?: [
    {
      "portId": number,
      "interfaceName": string,
      "portNumber": number,
      "portIdentity": string,
      "linkState": "UP"|"DOWN",
      "portState": "DISABLED"|"FAULTY"|"LISTENING"|"PRE_MASTER"|"MASTER"|"PASSIVE"|"UNCALIBRATED"|"SLAVE"|"INITIALIZING",
      "isMaster": boolean,
      "isSlave": boolean,
      "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"
  • portNumber: PTP端口号， 从1开始
  • portIdentity: PTP端口标识符, 如 "18e204.fffe.f005ce-1",
  • linkState: PTP端口的链路状态，UP表示链路正常，DOWN表示链路异常
  • portState: PTP端口的状态，参考IEEE1588-2008标准
    • DISABLED: 禁用状态
    • FAULTY: 故障状态
    • LISTENING: 监听状态
    • PRE_MASTER: 前置主状态
    • MASTER: 主状态
    • PASSIVE: 被动状态
    • UNCALIBRATED: 未校准状态
    • SLAVE: 从状态
    • INITIALIZING: 初始化状态
  • isMaster: 是否为主时钟
  • isSlave: 是否为从时钟
  • lastUpdate: 最后更新时间戳，单位为秒

正确响应结果示例：

{
  "success": true,
  "data": [
    {
      "portId": 0,
      "interfaceName": "eth210",
      "portNumber": 1,
      "portIdentity": "18e204.fffe.f005ce-1",
      "linkState": "UP",
      "portState": "MASTER",
      "isMaster": true,
      "isSlave": false,
      "lastUpdate": 1700000000
    },
    ...
  ]   
}

错误响应结果示例：

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

错误码​

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

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