Skip to main content

get_hot_backup_params 获取当前NTP客户端的热备份参数信息

POST /api/v1/ntp/get_hot_backup_params​

描述​

获取当前NTP的热备份参数信息. 用于主备热备份切换。

访问权限​

具备以下权限：

ntp:get_hot_backup_params

JSON参数​

请求参数如下：

{}

无参数, 传递空对象即可

请求示例：

{}

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false,
  "data"?: {
    "ntpHotBackup": "enable"|"disable",
    "interface": string,
    "state": "MASTER"|"BACKUP",
    "virtualIpAddress": string,
    "virtualRouterId": number,
    "advertInterval": number
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

tip
  • ntpHotBackup: NTP热备份状态, enable表示启用, disable表示禁用
  • interface: 热备份的接口名称, eth0表示mgmt1接口, eth1表示mgmt2接口, 接口名称列表来自 get_hot_backup_interfaces 接口返回值
  • state: 热备份的状态, MASTER表示主机, BACKUP表示备机
  • virtualIpAddress: 虚拟IP地址, 如果没有虚拟IP地址, 则返回空字符串。作为主身份的设备，利用虚拟IP地址提供NTP服务，切换时候备份机器会接管虚拟IP地址，持续提供NTP服务。
  • virtualRouterId: 虚拟路由器ID, 默认值是51，范围是1-255. 在同一个局域网中，所有参与同一个 VRRP 实例的设备（如主设备和备用设备）必须使用相同的 virtual_router_id
  • advertInterval: 虚拟路由器的广告间隔时间, 单位是秒, 默认值是1秒, 范围是1-255秒. 间隔时间越短，主机和备机之间的切换速度越快。

正确结果示例：

{
  "success": true,
  "data": {
    "ntpHotBackup": "enable",
    "interface": "eth0",
    "state": "MASTER",
    "virtualIpAddress": "192.168.188.3",
    "virtualRouterId": 51,
    "advertInterval": 1
  }
}

错误结果示例：

{
  "success": false,
  "errorCode": "40000",
  "errorMessage": "no.blank.params",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40000参数为空no.blank.params4
tip

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