POST /v2/list-service-fqdn-rules

Этот метод отображает список Service to FQDN правил, в соответствии с указанными данными в фильтрах. Один из фильтров обязателен для заполнения

Более подробно по организации БД можно посмотреть здесь.

Входные параметры

• byRuleName.names[] - Имена правил
• bySvcFrom.svcFrom[] - Массив/Список service(s)
• none - Показать весь список сущностей

название	обязательность	тип данных	Значение по умолчанию
				byRuleName.names[] || bySvcFromTo.svcFrom[] || none	да	Object[]	-

Пример использования (поиск по byRuleName)

curl '127.0.0.1:9006/v2/list-service-fqdn-rules' \
--header 'Content-Type: application/json' \
--data '{
    "byRuleName": {
        "names": [
            "rule-svc-svc-1",
            "rule-svc-svc-2"
        ]
    }
}'

Пример использования (поиск по bySvcFrom)

curl '127.0.0.1:9006/v2/list-service-fqdn-rules' \
--header 'Content-Type: application/json' \
--data '{
    "bySvcFrom": {
        "svcFrom": [
            "svc-3"
        ]
    }
}'

Пример использования (поиск по none)

curl '127.0.0.1:9006/v2/list-service-fqdn-rules' \
--header 'Content-Type: application/json' \
--data '{
  "none": {}
}'

Выходные параметры

• rules[] - Список описываемых правил.
• rules[].name - Имя правила.
• rules[].svcFrom - Имя сервиса откуда уходит трафик
• rules[].FQDN - Полное доменное имя (FQDN), для которого применяется данное правило.
• rules[].logs - Включить/отключить логирование.
• rules[].ports - Блок описывающий набор пар портов (source-destination).
• rules[].ports[].d - Набор открытых портов получателя
• rules[].ports[].s - Набор открытых портов отправителя.
• rules[].trace - Включить/отключить трассировку.
• rules[].transport - Протокол L3/L4 уровня модели OSI.
• rules[].action - Действие для пакетов в сформированных правил в цепочке.
• rules[].priority - Структура, содержащая описание порядка применения правил в цепочке.
• rules[].priority.some - Поле, определяющее порядок применения правил в цепочке.

название	тип данных
rules[]	Object[]
rules[].name	String
rules[].svcFrom	String
rules[].FQDN	String
rules[].ports	Object[]
rules[].ports[].d	String
rules[].ports[].s	String
rules[].transport	Enum("TCP", "UDP")
rules[].logs	Boolean
rules[].trace	Boolean
svcFqdnRules.rules[].action	Enum("ACCEPT", "DROP")
svcFqdnRules.rules[].priority	Object
svcFqdnRules.rules[].priority.some	Integer | String

Пример ответа

{
    "rules": [
        {
            "name": "rule-svc-fqdn-1",
            "svcFrom": "svc-3",
            "FQDN": "google.com",
            "transport": "TCP",
            "ports": [
                {
                    "s": "",
                    "d": "10000"
                }
            ],
            "logs": true,
            "trace": true,
            "action": "DROP",
            "priority": {
                "some": -32767
            }
        }
    ]
}

Возможные ошибки API

Не найден метод

• HTTP code: 404
• gRPC code: NOT_FOUND
• gRPC number: 5

Ошибка в указанных данных

• HTTP code: 500
• gRPC code: INTERNAL
• gRPC number: 13

Пользователь указал некорректные значения агрументов

• HTTP code: 400
• gRPC code: INVALID_ARGUMENT
• gRPC number: 3

Диаграмма последовательности