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

POST /v2/list-security-groups

Этот метод отображает список сетей (networks) и действия по умолчанию, в соответствии с указанным списком имен Security Groups.

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

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

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

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

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

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

  • $node.groups[] - Структура, содержащая описание создаваемых правил.
  • $node.groups[].name - Security Group, с которой устанавливаются правила взаимодействия.
  • $node.groups[].logs - Включить/отключить логирование.
  • $node.groups[].trace - Включить/отключить трассировку.
  • $node.groups[].networks - Массив/Список подсетей типа IP.
  • $node.groups[].defaultAction - Структура, содержащая описание создаваемых правил типа ICMP.
названиетип данных
$node.groups[]Object[]
$node.groups[].nameString
$node.groups[].logsBoolean
$node.groups[].traceBoolean
$node.groups[].networksObject[]
$node.groups[].defaultActionString

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

{
"groups": [{
"name": "sg-example",
"logs": "true",
"trace": "true",
"networks": ["network-example"],
"defaultAction": "DROP"
}]
}

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

Не найден метод
  • HTTP code: 404
  • gRPC code: NOT_FOUND
  • gRPC number: 5

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