跳到主要内容

get_static_routes_x 获取路由表状态信息

POST /api/v1/network/get_static_routes_x​

描述​

获取路由表的实时状态信息。此接口用于查询当前路由表的状态，包括各个路由条目的状态和相关信息。目的是配置和管理静态路由，以确保网络流量能够正确地传输到目标地址。

访问权限​

具备以下权限：

network:get_static_routes_x

请求参数​

{
  "interfaceName": "eth_ntp0"
}
  • interfaceName: 可选参数，指定要查询的网络接口名称。如果不提供此参数，则返回所有接口的路由信息。

返回结果​

返回结果如下：

{
  "success": true,
  "data": {
    "eth_ntp0": {
      "ipv4Routes": [
        {
          "destination": "string",
          "gateway": "string",
          "enabled": true,
          "metric": number,
          "destination": string,
          "tags": string,
        }
      ],
      "ipv6Routes": [
        {
          "destination": "string",
          "gateway": "string",
          "enabled": true,
          "metric": number,
          "destination": string,
          "tags": string,
        }
      ]
    }
  }
}
提示
  • ipv4Routes和ipv6Routes至少存在一个，如果都不存在则报错
  • ipv4Routes和ipv6Routes如果存在（可以存在一个，也可以两个都存在），对应的值必须是数组类型并且里面至少包含一个静态路由路由配置条目
  • 每个静态路由配置条目必须包含destination 和 gateway 字段，且不能为空
  • enabled字段是布尔类型，取值必须是true或false，如果不是则报错
  • destination字段必须是合法的IP地址段（CIDR格式），如果不是则报错
  • gateway字段必须是合法的单个IP地址，如果不是则报错
  • metric字段是整数类型，可选，取值范围0~4294967295 (2^32 - 1)，如果不提供则使用原有配置文件中的值，如果配置文件中也没有则使用默认值100
  • description和tags字段可选（如果提供则更新，不提供则保持原有配置文件的内容，如果配置中也没有则写入默认值为空字符串）

例子：

{
  "success": true,
  "data": {
    "eth_ntp0": {
      "ipv4Routes": [
        {
          "destination": "192.168.1.0/24",
          "gateway": "192.168.1.1",
          "enabled": true,
          "metric": 100,
          "description": "Local network route",
          "tags": "local,home"
        },
        {
          "destination": "192.168.2.0/24",
          "gateway": "192.168.2.1",
          "enabled": true,
          "metric": 100,
          "description": "Backup network route",
          "tags": "backup,office"
        }
      ],
      "ipv6Routes": [
        {
          "destination": "2001:db8::/32",
          "gateway": "2001:db8::1",
          "enabled": false,
          "metric": 100,
          "description": "IPv6 test route",
          "tags": "ipv6,test"
        }
      ]
    }
  }
}