Skip to main content

get_vlan_x 获取VLAN设备参数

POST /api/v1/network/get_vlan_x​

描述​

获取VLAN设备参数接口，用于获取指定VLAN设备的详细信息。这个接口用于在网络配置主页面显示指定VLAN设备的状态信息。 对应命令 nmcli connection show <vlanName>。

访问权限​

需要登录，具备以下权限：

network:get_connection_x

JSON参数​

请求参数如下：

{
  "vlanName": "string" // 设备名称，如vlan0, vlan1等
}
tip
  • vlanName: 设备名称，如vlan0, vlan1等

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false,
  "data"?: {
    "vlanName": string, // 绑定连接名称，如bond0
    "masterDevice": string, // 主设备名称，如eth0
    "vlanId": number, // VLAN ID，IEEE 802.1Q 标准定义取值范围1-4094， 保留VLAN ID：0, 4095
    "ipv4Method": "dhcp"|"manual", // IPv4地址获取方式：如dhcp, manual
    "ipv4Address": string, // IPv4地址 xxx/xx 格式， CIDR格式，可以多个用逗号分隔
    "ipv4Gateway": string, // IPv4网关
    "ipv6Method": "auto"|"dhcp"|"manual", // IPv6地址获取方式：如auto dhcp, manual
    "ipv6Address": string, // IPv6地址 xxx/xx 格式， CIDR格式，可以多个用逗号分隔
    "ipv6Gateway": string, // IPv6网关
    "tags": "tag1,tag2", // 设备标签, 用于机器批量处理
    "description": string, // 设备描述, 用于用户备注用途
    "enabled": boolean, // 连接是否启用
    "priority": number // VLAN优先级 0-7，数值越大优先级越高（非必须字段，默认0）
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
tip
  • vlanName: 绑定连接名称，如bond0
  • masterDevice: 主设备名称，如eth0
  • vlanId: VLAN ID
  • ipv4Method: IPv4地址获取方式：如dhcp, manual
  • ipv4Address: IPv4地址 xxx/xx 格式
  • ipv4Gateway: IPv4网关
  • ipv6Method: IPv6地址获取方式：如auto dhcp, manual
  • ipv6Address: IPv6地址 xxx/xx 格式
  • ipv6Gateway: IPv6网关
  • tags: 设备标签, 用于用户备注用途