全局 IP 列表

目录结构

|-- global_ip_lists/
  |-- global_ip_lists.yaml
  |-- ...

YAML 文件中可以包含一个或多个全局 IP 列表。

配置说明

参数名数据类型是否必选描述
namestring全局 IP 列表的名称,也是该列表的唯一标识
typestringIP 列表的类型,可以是 “ipv4” 或 “ipv6”
itemsarrayIP 地址列表

items 配置

参数名数据类型是否必选描述
ipstringIP 地址

配置示例

- name: global-ip-list1
  type: ipv4
  items:
  - ip: 1.1.1.1
  - ip: 1.1.1.11
- name: global-ip-list2
  type: ipv4
  items:
  - ip: 1.1.1.1
  - ip: 1.1.1.2

此配置定义了两个全局 IP 列表,每个列表包含多个 IPv4 地址。

请注意,当前并未支持 IPv6 地址。

使用示例

更新配置到 OpenResty Edge 中:

edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l global_ip_lists -i /root/oredge-configs

从 OpenResty Edge 中导出配置:

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -E -l global_ip_lists

示例中均使用 -l global_ip_lists 来指定只导入/导出全局 IP 列表相关的配置。

注意事项

  1. 全局 IP 列表是一个全局配置,为了保持与多个本地配置的兼容性,在更新配置时不会执行删除操作。

  2. 每个全局 IP 列表必须有一个唯一的名称。

  3. IP 列表的类型必须是 “ipv4”。

  4. 在添加或更新 IP 列表时,工具会检查 IP 地址的有效性。

  5. 在更新配置时,工具会比较新旧配置来确定是否需要更新。如果配置有变化,则会执行更新操作。

  6. 在导入配置时,工具会先检查配置的有效性,然后再执行添加或更新操作。

  7. 在导出配置时,工具会格式化 YAML 内容,只包含必要的信息(名称、类型和 IP 地址)。

  8. IP 列表可以被其他功能引用,如“页面规则 - 条件”等。

相关文档