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

POST /v2/list-security-groups

Этот метод отображает список Security Groups и их содержимое в соответствии с указанным списком имен

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

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

  • sgNames[] - Список, содержащий названия Security Group(s). Если не указывать значений, то отобразится весь спиок
названиеобязательностьтип данныхЗначение по умолчанию
sgNames[]нетString[][]

Пример использования

curl '127.0.0.1:9007/v2/list-security-groups' \
--header 'Content-Type: application/json' \
--data '{
"sgNames": [
"sg-0",
"sg-1"
]
}'

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

  • groups[] - Список Security Groups с составляющими
  • groups[].name - Имя Security Group
  • groups[].logs - Включить/отключить логирование.
  • groups[].trace - Включить/отключить трассировку.
  • groups[].networks - Массив/Список подсетей типа IP.
  • groups[].hosts - Массив/Список хостов
  • groups[].services - Массив/Список service(s)
  • groups[].defaultAction - Действие по умолчанию.
названиетип данных
groups[]Object[]
groups[].nameString
groups[].logsBoolean
groups[].traceBoolean
groups[].networksString[]
groups[].hostsString[]
groups[].servicesString[]
groups[].defaultActionString

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

{
"groups": [
{
"name": "sg-0",
"networks": [
"nw-0"
],
"defaultAction": "ACCEPT",
"trace": true,
"logs": true,
"hosts": [
"host-2",
"host-1"
],
"services": [
"svc-1",
"svc-3",
"svc-4"
]
}
]
}

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

Пользователь указал некорректные значения агрументов
  • HTTP code: 400
  • gRPC code: INVALID_ARGUMENT
  • gRPC number: 3
Ошибка в указанных данных
  • HTTP code: 500
  • gRPC code: INTERNAL
  • gRPC number: 13
Не найден метод
  • HTTP code: 404
  • gRPC code: NOT_FOUND
  • gRPC number: 5

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