プロキシグループ共通フィールド
プロキシグループ(proxy-groups)は複数のノードを1つのまとまりにラップしたもので、ルール内では単一のノードと同じように参照できます。6種類のタイプ(select/url-test/fallback/load-balance/relay など)はこの共通フィールドを共有します。
設定例
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オプション1つ以上のプロキシプロバイダー(proxy-providers)を読み込みます。
ヘルスチェック
urlオプションヘルスチェック用のテストアドレス。注意:proxies フィールド内のプロキシのみチェックされ、use で読み込んだプロキシプロバイダーのノードはチェックされません(それらはプロバイダー自身の health-check が担当します)。
intervalオプションヘルスチェックの間隔。0 以外の場合は定期テストが有効になります(単位:秒)。
lazyデフォルト true遅延ステータス。現在選択/使用されていない場合はテストを行わず、リソースを節約します。
timeoutオプションヘルスチェックのタイムアウト時間(単位:ミリ秒)。
max-failed-timesデフォルト 5最大失敗回数。これを超えると強制的にヘルスチェックが1回トリガーされます。
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 にカスタムアイコン文字列を返させます。対応するダッシュボードと組み合わせて表示に使用します |