Перейти к основному содержимому

POST /v2/list-service-rules

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

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

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

  • byRuleName.names[] - Имена правил
  • bySvcFromTo.svcFrom[] - Массив/Список service(s)
  • bySvcFromTo.svcTo[] - Массив/Список service(s)
  • none - Показать весь список сущностей
названиеобязательностьтип данныхЗначение по умолчанию
byRuleName.names[] || bySvcFromTo.svcFrom[] || bySvcFromTo.svcTo[] || noneдаObject[] -

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

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

Пример использования (поиск по bySvcFromTo, svcFrom/svcTo можно использовать как одновременно, так и по отдельности)

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

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

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

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

  • rules[] - Структура, содержащая описание создаваемых правил.
  • rules[].name - Имя правила.
  • rules[].svcFrom - Имя сервиса откуда уходит трафик
  • rules[].svcTo - Имя сервиса куда уходит трафик
  • rules[].logs - Включить/отключить логирование.
  • rules[].action - Действие для пакетов в сформированных правил в цепочке.
  • rules[].priority - Структура, содержащая описание порядка применения правил в цепочке.
  • rules[].priority.some - Поле, определяющее порядок применения правил в цепочке.
названиетип данных
rules[]Object[]
rules[].nameString
rules[].svcFromString
rules[].logsBoolean
rules[].svcToString
rules[].actionString
rules[].priorityObject
rules[].priority.someInteger

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

{
"rules": [
{
"name": "rule-svc-svc-1",
"svcFrom": "svc-3",
"svcTo": "svc-4",
"action": "DROP",
"priority": {
"some": -32767
},
"logs": true,
"trace": false
}
]
}

Возможные ошибки 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

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