Skip to main content

save_static_routes_x 保存路由表配置信息

POST /api/v1/network/save_static_routes_x​

描述​

保存路由表的配置信息。此接口用于更新和保存静态路由的配置，包括添加、修改或删除路由条目。目的是确保网络流量能够正确地传输到目标地址。

访问权限​

具备以下权限：

network:save_static_routes_x

请求参数​

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

例子：

{
  "interfaceName": "eth_ntp5",
  "ipv4Routes": [
    {
      "destination": "192.168.166.0/24",
      "gateway": "192.168.188.2",
      "metric": 100,
      "description": "Route to 166 subnet via secondary gateway (not default gateway)",
      "enabled": true,
      "tags": "management,secondary-subnet"
    }
  ],
  "ipv6Routes": [
    {
      "destination": "::/0",
      "gateway": "::",
      "metric": 100,
      "description": "Not configured - edit destination/gateway to enable",
      "enabled": false,
      "tags": "mgmt,management,admin" 
    }
  ]
}

响应结果​

请求返回的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
}