API

Пример запроса

Пример curl curl -H 'Authorization: Bearer ${secret}' http://${controller-api}/configs?force=true -d '{"path": "", "payload": ""}' -X PUT

Этот запрос содержит заголовок 'Authorization: Bearer ${secret}', где:

${secret} - ключ API, заданный в разделе API конфигурационного файла
${controller-api} - адрес прослушивания, заданный в разделе API конфигурационного файла
?force=true - параметр, который требуется для некоторых запросов
'{"path": "", "payload": ""}' - данные обновляемого ресурса

Логи

`/logs`

Метод запроса: GET / WS
Необязательный параметр: ?level=log_level, где log_level может быть info, warning, error, debug
Необязательный параметр: ?format=structured, при наличии выводит структурированные логи (с полями time, level, message, fields)
Поля ответа в стандартном режиме (один объект JSON на строку):
- type: уровень логирования - info / warning / error / debug
- payload: текст сообщения журнала
Поля ответа в структурированном режиме ?format=structured:
- time: время в формате HH:MM:SS
- level: уровень логирования
- message: текст сообщения журнала
- fields: массив дополнительных полей

Информация о трафике

`/traffic`

Метод запроса: GET / WS
Поля ответа (отправляются раз в секунду):
- up: текущая скорость исходящего трафика (байт/с)
- down: текущая скорость входящего трафика (байт/с)
- upTotal: суммарное количество отправленных байтов
- downTotal: суммарное количество полученных байтов

Информация о памяти

`/memory`

Метод запроса: GET / WS
Поля ответа (отправляются раз в секунду):
- inuse: текущий объем используемой памяти (байты)
- oslimit: системное ограничение памяти (байты, всегда 0)

Информация о версии

`/version`

Метод запроса: GET
Поля ответа:
- meta: является ли сборка версией Meta (true / false)
- version: строка версии

Кэш

`/cache/fakeip/flush`

Метод запроса: POST
Ответ отсутствует (HTTP 204)

`/cache/dns/flush`

Метод запроса: POST
Ответ отсутствует (HTTP 204)

`/cache/smart/flush` 👻

Метод запроса: POST
Ответ: нет (HTTP 204)

`/cache/smart/flush/:config` 👻

Метод запроса: POST
Ответ: нет (HTTP 204)

Рабочая конфигурация

`/configs`

Метод запроса: GET
Поля ответа: JSON-объект текущей рабочей конфигурации, включая port, socks-port, mixed-port, mode, log-level, allow-lan, ipv6, tun и другие поля

Метод запроса: PUT
Параметр: ?force=true
Ответ отсутствует (HTTP 204)

Метод запроса: PATCH
Данные: '{"mixed-port": 7890}'
Ответ отсутствует (HTTP 204)

`/configs/geo`

Метод запроса: POST
Данные: '{"path": "", "payload": ""}'
Ответ отсутствует (HTTP 204)

`/restart`

Метод запроса: POST
Данные: '{"path": "", "payload": ""}'
Ответ отсутствует (HTTP 204)

Обновления

`/upgrade`

Метод запроса: POST
Необязательные параметры: ?channel=xxx задаёт канал обновления, ?force=true принудительное обновление
Данные: '{"path": "", "payload": ""}'
Поля ответа:
- status: фиксированное значение "ok"

`/upgrade/ui`

Метод запроса: POST
Поля ответа:
- status: фиксированное значение "ok"

`/upgrade/geo`

Метод запроса: POST
Данные: '{"path": "", "payload": ""}'
Ответ отсутствует (HTTP 204)

`/upgrade/lgbm` 👻

Метод запроса: POST

Группы политик

`/group`

Метод запроса: GET
Поля ответа:
- proxies: массив объектов групп политик; формат каждого объекта совпадает с ответом /proxies/proxies_name

`/group/group_name`

Метод запроса: GET
Поля ответа: объект группы политик в формате /proxies/proxies_name

`/group/group_name/delay`

Метод запроса: GET
Параметр: ?url=xxx&timeout=5000
Необязательный параметр: ?expected=xxx, ожидаемый код состояния HTTP-ответа, поддерживает диапазоны (например, 200/204, 200-299)
Поля ответа: JSON-объект, сопоставляющий имена узлов с задержкой в миллисекундах (uint16), например {"Узел A": 120, "Узел B": 350}

`/group/weights` 👻

Метод запроса: GET

`/group/group_name/weights` 👻

Метод запроса: GET
Ответ: {"weights": [...]}

Прокси

`/proxies`

Метод запроса: GET
Поля ответа:
- proxies: объект, ключами которого являются имена прокси или групп; каждая запись содержит следующие общие поля:
  - name: имя прокси или группы
  - type: тип, например Shadowsocks, VMess, DIRECT, Selector, URLTest, Fallback, LoadBalance
  - udp: поддерживается ли UDP
  - uot: поддерживается ли UDP over TCP
  - xudp: поддерживается ли XUDP
  - tfo: включен ли TCP Fast Open
  - mptcp: включен ли MPTCP
  - smux: включено ли мультиплексирование потоков
  - alive: доступен ли прокси в данный момент
  - history: массив записей истории задержек с полями time и delay (мс)
  - extra: дополнительная история задержек, сгруппированная по URL тестирования
  - interface: имя привязанного сетевого интерфейса
  - routing-mark: значение метки маршрутизации
  - provider-name: имя провайдера, которому принадлежит прокси
  - dialer-proxy: имя нижележащего dialer-прокси
- Группы политик (Selector, URLTest, Fallback, LoadBalance) дополнительно содержат:
  - now: имя выбранного сейчас узла (отсутствует у LoadBalance)
  - all: массив имен всех узлов и групп
  - testUrl: URL проверки работоспособности
  - hidden: скрыта ли группа в панели управления
  - icon: URL значка
  - emptyFallback: имя резервного узла, используемого при недоступности всех участников
  - expectedStatus: ожидаемый код HTTP-ответа при проверке (отсутствует у Selector)
  - fixed: закрепленный сейчас узел (только для URLTest и Fallback)

`/proxies/proxies_name`

Метод запроса: GET
Поля ответа: объект прокси или группы с полями одной записи из /proxies; обычные прокси содержат только общие поля, а группы политик также содержат now, all и другие поля группы

Метод запроса: PUT
Данные: '{"name":"Япония"}'
Ответ отсутствует (HTTP 204)

Метод запроса: DELETE
Ответ отсутствует (HTTP 204)

`/proxies/proxies_name/delay`

Метод запроса: GET
Параметр: ?url=xxx&timeout=5000
Необязательный параметр: ?expected=xxx, ожидаемый код состояния HTTP-ответа, поддерживает диапазоны (например, 200/204, 200-299)
Поля ответа:
- delay: измеренная задержка в миллисекундах (uint16)

Наборы прокси

`/providers/proxies`

Метод запроса: GET
Поля ответа:
- providers: объект, ключами которого являются имена провайдеров; каждая запись содержит метаданные провайдера и список его прокси

`/providers/proxies/providers_name`

Метод запроса: GET
Поля ответа: объект провайдера прокси, включающий метаданные конфигурации и список proxies

Метод запроса: PUT
Ответ отсутствует (HTTP 204)

`/providers/proxies/providers_name/healthcheck`

Метод запроса: GET
Ответ отсутствует (HTTP 204)

`/providers/proxies/providers_name/proxies_name`

Метод запроса: GET
Поля ответа: объект прокси с теми же полями, что и /proxies/proxies_name

`/providers/proxies/providers_name/proxies_name/healthcheck`

Метод запроса: GET
Параметр: ?url=xxx&timeout=5000
Поля ответа:
- delay: измеренная задержка в миллисекундах (uint16)

Правила

`/rules`

Метод запроса: GET
Поля ответа:
- rules: массив объектов правил, каждый из которых содержит:
  - index: индекс правила, начиная с 0
  - type: тип правила, например DOMAIN, IP-CIDR, GEOIP
  - payload: содержимое условия правила
  - proxy: имя целевого прокси или группы политик
  - size: количество записей в наборе правил (только для GEOIP / GEOSITE, в остальных случаях -1)
  - extra (необязательно) содержит:
    - disabled: отключено ли правило
    - hitCount: количество совпадений с правилом
    - hitAt: время последнего совпадения
    - missCount: количество несовпадений с правилом
    - missAt: время последнего несовпадения

`/rules/disable`

Метод запроса: PATCH
Данные: '{"0": false,"1": true}'
Ответ отсутствует (HTTP 204)

Наборы правил

`/providers/rules`

Метод запроса: GET
Поля ответа:
- providers: объект, ключами которого являются имена провайдеров правил

`/providers/rules/providers_name`

Метод запроса: PUT
Ответ отсутствует (HTTP 204)

Соединения

`/connections`

Метод запроса: GET / WS
Необязательный параметр: ?interval=milliseconds, где milliseconds - интервал обновления, стандартное значение 1000 миллисекунд
Поля ответа:
- downloadTotal: суммарное количество полученных байтов
- uploadTotal: суммарное количество отправленных байтов
- memory: текущий объем используемой памяти (байты)
- connections: массив объектов активных соединений, каждый из которых содержит:
  - id: уникальный идентификатор соединения
  - metadata: метаданные соединения (адреса источника и назначения, протокол, имя процесса и т. д.)
  - upload: количество байтов, отправленных через это соединение
  - download: количество байтов, полученных через это соединение
  - start: время начала соединения
  - chains: массив цепочки прокси
  - providerChains: массив цепочки провайдеров прокси
  - rule: тип совпавшего правила
  - rulePayload: содержимое совпавшего правила

Метод запроса: DELETE
Ответ отсутствует (HTTP 204)

`/connections/:id`

Метод запроса: DELETE
Ответ отсутствует (HTTP 204)

`/connections/smart/:id` 👻

Метод запроса: DELETE
Ответ: нет (HTTP 204)

DNS запросы

`/dns/query`

Метод запроса: GET
Параметр: ?name=example.com&type=A
Поля ответа:
- Status: код DNS-ответа (Rcode)
- Question: массив вопросов запроса
- TC: был ли ответ усечен
- RD: флаг запроса рекурсии
- RA: флаг доступности рекурсии
- AD: флаг аутентифицированных данных
- CD: флаг отключения проверки
- Answer (необязательно): массив записей ответа с полями name, type, TTL, data
- Authority (необязательно): массив авторитетных записей в том же формате, что и Answer
- Additional (необязательно): массив дополнительных записей в том же формате, что и Answer

Хранилище

`/storage/key`

Метод запроса: GET
Поля ответа: любое сохраненное допустимое значение JSON или null, если ключ не существует

Метод запроса: PUT
Данные: '{"foo": "bar"}'
Ответ отсутствует (HTTP 204)

Метод запроса: DELETE
Ответ отсутствует (HTTP 204)

DEBUG

/debug требует, чтобы при запуске ядра уровень логирования был установлен на debug.

`/debug/gc`

Метод запроса: PUT
Ответ отсутствует (HTTP 204)

`/debug/pprof`

Открыв в браузере http://${controller-api}/debug/pprof, можно просмотреть исходную отладочную информацию, где:

allocs показывает ситуацию с выделением памяти для каждого вызова функции, включая размер памяти, выделенной в стеке и куче, а также количество выделений памяти. Этот отчет в основном помогает находить проблемы с утечками памяти и частыми запросами на выделение памяти в коде.
отчет heap предоставляет подробную информацию об использовании памяти в куче программой, включая размер, количество и адреса выделенных блоков памяти, отсортированных по размеру. Этот отчет в основном используется для поиска мест с высоким использованием памяти, можно просмотреть размеры объектов в отчете heap, чтобы найти места с высоким использованием памяти.

Установите Graphviz, чтобы просматривать графическую отладочную информацию

Просмотр графического отчета Heap

go tool pprof -http=:8080 http://127.0.0.1:xxxx/debug/pprof/heap

Полное изображение

Просмотр графического отчета Allocs

go tool pprof -http=:8080 http://127.0.0.1:xxxx/debug/pprof/allocs

Пример вывода

Отправка отчета

Откройте в браузере http://${controller-api}/debug/pprof/heap?raw=true, чтобы загрузить этот файл, и загрузите его в issues, чтобы сообщить о проблеме, с которой вы столкнулись.

API

Пример запроса

Логи

/logs

Информация о трафике

/traffic

Информация о памяти

/memory

Информация о версии

/version

Кэш

/cache/fakeip/flush

/cache/dns/flush

/cache/smart/flush 👻

/cache/smart/flush/:config 👻

Рабочая конфигурация

/configs

/configs/geo

/restart

Обновления

/upgrade

/upgrade/ui

/upgrade/geo

/upgrade/lgbm 👻

Группы политик

/group

/group/group_name

/group/group_name/delay

/group/weights 👻

/group/group_name/weights 👻