API
ℹ️
Справочник API-методов системы 5А входит в поставку и открывается в браузере по адресу https://<Адрес сервера бэкенда>:8443/api/v1/docs — это адрес веб-интерфейса с добавленным путём /api/v1/docs.
Краткое описание групп API-методов
| Группа методов в Swagger | Краткое описание |
|---|---|
| Auth | Авторизация пользователей и управление токенами в системе 5А |
| Clusters | Управление кластерами балансировки нагрузки и отказоустойчивостью GSLB-кластера (BGP/VRRP) |
| Cluster VRF | Управление VRF-профилями и Cross-VRF политиками в кластере |
| Cluster Monitors | Управление мониторами серверов пользовательского сервиса, включая XML/SOAP-мониторы и заголовки запросов |
| Cluster Certificates | Управление SSL-сертификатами кластеров |
| Cluster ICAP Servers | Управление ICAP-серверами в кластере балансировки |
| SLB Cluster Auth Profiles | Управление профилями аутентификации в кластере SLB |
| SLB Cluster Auth User Sets | Управление наборами пользователей в кластере SLB |
| SLB Cluster Auth Providers | Управление провайдерами аутентификации (OIDC) в кластере SLB |
| SLB Cluster Agents | Управление агентами кластера SLB |
| SLB Cluster Nodes Groups | Управление клиентскими серверами и группами серверов в кластере SLB |
| SLB Cluster Scripts | Управление сценариями обработки трафика в кластере SLB |
| SLB Cluster Policy | Управление политиками распределения нагрузки в кластере SLB |
| SLB Cluster Services | Управление конфигурациями балансировки в кластере SLB, в том числе блоком зеркалирования трафика |
| SLB Cluster Versions | Версионирование конфигураций кластера SLB |
| SLB Cluster SNAT Pools | Управление SNAT-пулами в кластере SLB |
| GSLB Cluster Hosts | Управление клиентскими серверами в кластере GSLB |
| GSLB Cluster Servers | Управление серверами кластера GSLB |
| GSLB Cluster Policies | Управление правилами модификации DNS в кластере GSLB |
| GSLB Cluster Rules | Управление правилами маршрутизации в кластере GSLB |
| GSLB Cluster DNS Zone | Управление DNS-зонами в кластере GSLB |
| GSLB Cluster DNS Record | Управление DNS-записями в кластере GSLB |
| GSLB Cluster DNS Servers | Управление DNS-серверами в кластере GSLB |
| GSLB Cluster DNSSEC Keyset | Управление DNSSEC-ключами в кластере GSLB |
| GSLB Cluster Versions | Версионирование компонентов кластера GSLB |
| Network Agent Cluster | Управление сетевыми интерфейсами, конфигурацией FRR, фильтрами и NAT сетевых агентов, а также запуск диагностических утилит: Ping, Traceroute, MTR, DNS Lookup, cURL и TCP Dump — см. Диагностика |
| Dictionary | Справочники и системные данные |
| Users | Управление пользователями системы 5А |
| Roles | Управление ролями и назначением ролей пользователям и группам |
| Local Groups | Управление локальными группами и назначением им ролей |
| LDAPs | Управление конфигурациями входа через LDAP и группами каталога |
| Personal Access Tokens | Управление персональными токенами доступа (PAT) |
| License | Управление лицензиями системы 5А |
| System | Системные параметры и информация о состоянии системы |
| Audit | Журнал аудита: просмотр истории операций и настройки аудита |