文档 配置 代理组通用字段

代理组通用字段

策略组(proxy-groups)是把一批节点包装成一个整体,规则里可以像引用单个节点一样引用它。6 种类型(select/url-test/fallback/load-balance/relay 等)都共享这一批字段。

配置示例

config.yaml YAML
proxy-groups:
  - name: "proxy"
    type: select
    proxies:
      - DIRECT
      - ss
    use:
      - provider1
    url: 'https://www.gstatic.com/generate_204'
    interval: 300
    lazy: true
    filter: "(?i)港|hk|hongkong|hong kong"
    exclude-filter: "美|日"
    exclude-type: "Shadowsocks|Http"

基础字段

name必须

策略组名字,含特殊符号时要用引号包裹。

type必须

策略组类型:select/url-test/fallback/load-balance/relay

proxies可选

引入出站代理或其他策略组,按数组顺序排列。

use可选

引入一个或多个代理集合(proxy-providers)。

健康检查

url可选

健康检查测试地址。注意:只会检查 proxies 字段里的代理,不会检查通过 use 引入的代理集合节点(那些由集合自己的 health-check 负责)。

interval可选

健康检查间隔,不为 0 则启用定时测试,单位秒。

lazy默认 true

懒惰状态,当前未被选中/使用时不进行测试,省资源。

timeout可选

健康检查超时时间,单位毫秒。

max-failed-times默认 5

最大失败次数,超过后触发一次强制健康检查。

expected-status默认 *

期望的 HTTP 响应状态码,配置后只有响应码匹配才认为节点可用。写法支持 / 匹配多个状态码、- 匹配范围,可混合书写,如 200/302/400-503

批量引入与筛选

include-all / include-all-proxies / include-all-providers可选

批量引入全部出站代理和/或全部代理集合(按名称排序),不含策略组本身;include-all-providers 会使 use 字段失效。

filter / exclude-filter可选

关键词/正则筛选或排除节点,仅作用于引入的代理集合和批量引入的全部代理,多个正则用 ` 分隔。

exclude-type可选

不支持正则,用 | 分割按类型排除,仅作用于引入的出站代理。

其它字段

字段说明
default-selected默认选择的节点,为空或节点不存在时默认选第一个
empty-fallback组内节点为空时的回退出站,默认 COMPATIBLE,只能填代理名不能填策略组
disable-udp禁用该策略组的 UDP
hidden让 API 返回 hidden 状态,前端适配后可以隐藏该策略组展示
icon让 API 返回自定义图标字符串,配合支持的面板显示