Управление сетевым фильтром ap (bannedaddrs)
Обзор
Предоставляет доступ к оперативным данным пограничного сетевого фильтра всех экземпляров роли ap.
Автоматическая блокировка IP-адреса происходит при многократном повторном получении с него autoprovision (TFTP, PnP)-запросов с неверными авторизационными данными в течение ограниченного интервала времени. Автоматическая блокировка производится на конкретном экземпляре роли ap. Добавляемые в список через API размещаются в списках запрещенных адресов на всех доступных экземплярах роли ap.
Отображает все заблокированные IP-адреса и время блокировки - как автоматически заблокированные, так и добавленные администратором мастер-домена. Также позволяет работать со списком заблокированных IP-адресов: добавлять, удалять, очищать.
Запросы
| HTTP verb | Endpoint | Описание |
|---|---|---|
|
|
|
|
|
Получение списка экземпляров ролей esg и заблокированных IP-адресов |
|
|
|
|
|
Общие скоуп-параметры запросов
Приведенные параметры используются в URL (?param=value) для ограничения скоупа применения запроса (состава экземпляров ролей, к которым применяется запрос).
Все они являются опциональными и могут отсутствовать.
Имеет смысл указывать не более одного из них, либо не указывать ни одного.
| Имя | Тип | Описание |
|---|---|---|
|
|
Имя сайта из конфигурации. Например |
|
|
Список имен сайтов, разделенных запятыми. Например |
|
|
Алиас сервера. Может быть IP адресом, номером или полным именем сервера из конфигурации. Например |
|
|
Список алиасов серверов, разделенных запятыми. Например |
Добавление IP-адреса в списки заблокированных
Добавляет произвольный IP-адрес в списки запрещенных IP-адресов роли ap.
Запрос распараллеливается для выполнения на всех экземплярах роли ap, входящих в скоуп, указанный параметрами в URL.
Запрос
URL может содержать дополнительные скоуп-параметры.
| Имя | Тип | Описание |
|---|---|---|
|
|
IPV4-адрес, подлежащий блокировке. |
|
|
Интервал времени в секундах, по истечении которого адрес должен быть автоматически удален. Каждый последующий запрос для указанного адреса продляет таймер автоудаления. |
POST /rest/v1/master/logicalroles/ap/bannedaddrs?site=SITE1 HTTP/1.1
Content-Type: application/json; charset=utf-8
{
"ip": "212.54.68.68",
"expires": "600"
}Ответ
Содержит список объектов-представлений всех экземпляров роли ap, входящих в скоуп запроса. Каждый объект содержит статус и результат выполнения запроса.
| Имя | Описание |
|---|---|
|
Имя сайта, на котором находится текущий экземпляр роли ap. |
|
Имя ноды, на которой исполняется текущий экземляр роли ap. |
|
Номер сервера из конфигурации, на котором выполняется нода с текущим экземпляром роли ap |
|
Адрес сервера из конфигурации, на котором выполняется нода с текущим экземпляром роли ap |
|
Признак активности/доступности экземпляра роли с веб-сервера, обслуживающего запрос.
|
|
Для активных и доступных экземпляров указывает результат выполнения операции.
|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"site": "SITE1",
"node": "esg131@192.168.0.13",
"srvidx": 0,
"addr": "192.168.0.13",
"online": true,
"result": true
},
{
"site": "SITE1",
"node": "esg141@192.168.0.14",
"srvidx": 0,
"addr": "192.168.0.14",
"online": true
},
{
"site": "SITE1",
"node": "esg142@192.168.0.14",
"srvidx": 0,
"addr": "192.168.0.14",
"online": false
}
]Получение списка экземпляров ролей esg и заблокированных IP-адресов
Возвращает список объектов-представлений всех экземпляров роли ap, входящих в скоуп запроса, указанный скоуп-параметрами в URL.
Каждый объект содержит статус экземпляра роли и список заблокированных IP-адресов на этом экземпляре роли в случае, если он активен и доступен.
Запрос
| Имя | Тип | Описание |
|---|---|---|
|
|
Фильтр по значениям полей. |
|
|
Список полей для вывода. Доступные поля для выдачи: |
|
|
Смещение в списке ресурсов, подлежащих выдаче. |
|
|
Максимальное количество ресурсов в списке. |
|
|
Порядок сортировки ресурсов в списке. |
|
|
Преобразование в плоский вид составных полей. |
URL может содержать дополнительные скоуп-параметры.
GET /rest/v1/master/master/logicalroles/ap/bannedaddrs?site=SITE1,mask=banned,node,online&limit=2 HTTP/1.1Ответ
Содержит список объектов, каждый из которых представляет конкретный экземпляр роли ap, входящий в скоуп запроса.
| Имя | Описание |
|---|---|
|
Имя сайта, на котором находится текущий экземпляр роли ap. |
|
Имя ноды, на которой исполняется текущий экземляр роли ap. |
|
Номер сервера из конфигурации, на котором выполняется нода с текущим экземпляром роли ap |
|
Адрес сервера из конфигурации, на котором выполняется нода с текущим экземпляром роли ap |
|
Признак активности/доступности экземпляра роли с веб-сервера, обслуживающего запрос.
|
|
Список заблокированных IP-адресов. Каждый адрес в списке представлен объектом, имеющим поля:
|
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"site": "SITE1",
"node": "ap131@192.168.0.13",
"srvidx": 0,
"addr": "192.168.0.13",
"online": true,
"banned": [
{
"ip": "212.54.68.68",
"expires": 526
},
{
"ip": "187.13.93.27",
"expires": 277
}
]
},
{
"site": "SITE1",
"node": "ap141@192.168.0.14",
"srvidx": 0,
"addr": "192.168.0.14",
"online": true,
"banned": [
{
"ip": "212.54.68.68",
"expires": 526
}
]
},
{
"site": "SITE1",
"node": "esg142@192.168.0.14",
"srvidx": 0,
"addr": "192.168.0.14",
"online": false
}
]Очистка списков заблокированных адресов
Очищает списки заблокированных IP-адресов роли ap.
Запрос распараллеливается и применяется ко всем экземплярам ролей ap, входящих в скоуп, указанный скоуп-параметрами в URL.
Запрос
URL может содержать дополнительные скоуп-параметры.
DELETE /rest/v1/master/logicalroles/ap/bannedaddrs HTTP/1.1Удаление адреса из списка заблокированных адресов
Удаляет заблокированный IP-адрес из списка заблокированных IP-адресов роли ap.
Запрос распараллеливается и применяется ко всем экземплярам ролей ap, входящих в скоуп, указанный скоуп-параметрами в URL.
Запрос
URL может содержать дополнительные скоуп-параметры.
DELETE /rest/v1/master/logicalroles/ap/bannedaddrs/212.54.68.68 HTTP/1.1