Skip to main content

save_params 保存PTP参数

POST /api/v1/ptp/save_params_x​

描述​

保存PTP参数接口，用于保存PTP参数信息。

访问权限​

具备以下权限：

ptp:save_params

JSON参数​

请求参数如下：

{
  "id": 0~n,
  "serverOnly"?: 0|1, // 仅服务器 可选参数, 是否为仅服务器端口, 只读属性
  "delayMeasurement"?: "e2e" | "p2p",
  "networkTransport"?: "L2" | "UDPv4" | "UDPv6", // 可选参数, 网络传输方式
  "inhibitAnnounce"?: 0 | 1,  // 1-开启“仅接收时间“模式，类似仅从功能，不发送同步报文
  "logAnnounceInterval"?: -7~+7,
  "logSyncInterval"?: 2~10,
  "logMinDelayReqInterval"?: -7~+7,
  "logMinPdelayReqInterval"?: -7~+7, // 可选参数, PDelay Req 间隔
  "announceReceiptTimeout"?: 2~10,
  "delayAsymmetry" ?: number, // 可选参数, 非对称时延
  "egressLatency"?: number, // 可选参数, 输出延迟
  "ingressLatency": 0,
  "neighborPropDelayThresh": 20000000, // 等延迟的上限阈值
  "unicastMasterTable"?: 0|1|2|3  // 可选参数, 单播主时钟列表编号
}
tip
  • id: PTP参数编号. 从0开始
  • serverOnly: 仅服务器 可选参数, 是否为仅服务器端口, 只读属性, 值1表示仅服务器模式，0表示从端模式。注意：
    1. 针对PTP1 (ethi210): 只有当全局配置serverOnly=0时（TC版本，PTP1口可以切换到从时），才允许设置为0，其他情况都只能是1；
    2. 其他端口: 目前都是只能为1，暂时不支持从端模式；
    3. 全局配置serverOnly会根据时间源模式和卫星信号自动配置，前端不显示该字段
  • delayMeasurement: 延迟测量方式，取值为 "e2e"（端到端）或 "p2p"（点对点）
  • networkTransport: 网络传输方式，取值为 "L2"（二层）或 "UDPv4"（IPv4），“UDPv6” （IPv6）可选参数
  • inhibitAnnounce: 控制端口是否禁止发送PTP时钟宣告消息
    • 功能：控制端口是否禁止发送PTP时钟宣告消息
    • 作用：当设置为1时，端口只接收时间同步，不向网络中其他设备宣告自己的时钟信息，避免时钟竞争和网络中出现多个时钟源
    • 适用场景：纯从端设备、避免时钟冲突、单向时间同步需求
    • 取值范围：0=正常模式（可发送宣告），1=接收模式（禁止发送宣告）
  • logAnnounceInterval: Announce间隔，取值范围为-7到+7
  • logSyncInterval: Sync 间隔，取值范围为2到10
  • logMinDelayReqInterval: Delay Req 间隔，取值范围为-7到+7
  • logMinPdelayReqInterval: PDelay Req报文的日志间隔，取值范围为-7到+7
  • announceReceiptTimeout: Announce接收超时 时间，取值范围为2到10
  • delayAsymmetry: 非对称时延，单位为纳秒（ns），可选参数
  • egressLatency: 输出延迟，单位为纳秒（ns），可选参数
  • ingressLatency: 输入延迟，单位为纳秒（ns），可选参数
  • neighborPropDelayThresh: 邻居属性延迟阈值，单位为纳秒（ns），可选参数
    • 功能：设置对等延迟测量的阈值上限（纳秒）
    • 作用：当测量的邻居传播延迟超过此阈值时，端口可能被标记为不符合PTP规范，用于网络质量检测和链路健康监控
    • 适用场景：gPTP网络质量控制、G.8275.1/G.8275.2链路监控、网络故障检测
    • 推荐值：局域网10-20ms，城域网50-100ms，广域网100-200ms
  • unicastMasterTable: 单播主时钟列表编号，可选参数，取值0、1、2、3，表示使用不同的单播主时钟列表配置编号
    1. 用于指定本端口使用的主时钟列表编号，针对PTP1 (ethi210)工作在SLave模式才有意义，其他端口目前都只能是MASTER模式，配置无意义
    2. 0表示禁用单播（默认多播）
    3. 值为1|2|3分别对应“L2"|"UDPv4“|”UDPv6"

请求示例：

{
  "id": 1,
  "delayMeasurement": "p2p",
  "logAnnounceInterval": 2,
  "announceReceiptTimeout": 4,
  "logSyncInterval": 5,
  "logMinDelayReqInterval": 1,
  "logMinPdelayReqInterval": 0,
  "delayAsymmetry": 8,
  "egressLatency": 10,
  "networkTransport": "L2"
}

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false, 
  "errorCode": "option string",
  "errorMessage": "option string",
  "showType": 0|1|2|4|9,
  "traceId": "option string"
}

正确响应结果示例：

{
  "success": true
}

错误响应结果示例：

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

错误码​

错误码说明错误信息显示类型
40007必须有ID参数ptp.param.id.required4
40007id 范围不正确ptp.param.id.range4
tip

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