POST /v2/list-services

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

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

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

bySvcName.names[] - Массив/Список service(s)
bySgName.names[] - Массив/Список имен Security Group(s).
none - Показать весь список сущностей

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

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

curl '127.0.0.1:9006/v2/list-services' \
--header 'Content-Type: application/json' \
--data '{
    "bySgName": {
        "names": [
            "sg-6", "sg-0"
        ]
    }
}'

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

curl '127.0.0.1:9006/v2/list-services' \
--header 'Content-Type: application/json' \
--data '{
    "bySvcName": {
        "names": [
            "svc-4",
            "svc-5"
        ]
    }
}'

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

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

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

services.services[] - Структура, содержащая список сервисов.
services.services[].name - Имя сервиса.
services.services[].sgNames - Массив/Список имен Security Group(s).
services.services[].protocols - Список используемых протоколов.
services.services[].protocols.tcp - Структура, содержащая список портов для протокола TCP.
services.services[].protocols.tcp.ports - Блок описывающий набор пар портов (source-destination).
services.services[].protocols.tcp.ports[].d - Набор открытых портов получателя
services.services[].protocols.tcp.ports[].s - Набор открытых портов отправителя.
services.services[].protocols.udp - Структура, содержащая список портов для протокола UDP.
services.services[].protocols.udp.ports - Блок описывающий набор пар портов (source-destination).
services.services[].protocols.udp.ports[].d - Набор открытых портов получателя
services.services[].protocols.udp.ports[].s - Набор открытых портов отправителя.
services.services[].protocols.icmpv4 - Объект, определяющий параметры настройки ICMP для сетей, использующих IPv4.
services.services[].protocols.icmpv4.types - Список, определяющий допустимые типы ICMP запросов для сетей, использующих IPv4.
services.services[].protocols.icmpv6 - Объект, определяющий параметры настройки ICMP для сетей, использующих IPv6.
services.services[].protocols.icmpv6.types - Список, определяющий допустимые типы ICMP запросов для сетей, использующих IPv6.

название	тип данных
services[]	Object[]
services[].name	String
services[].sgNames	String[]
services[].protocols	Object
services[].protocols.tcp	Object \|\| null
services[].protocols.tcp.ports	Object[]
services[].protocols.tcp.ports[].d	String
services[].protocols.tcp.ports[].s	String
services[].protocols.udp	Object \|\| null
services[].protocols.udp.ports	Object[]
services[].protocols.udp.ports[].d	String
services[].protocols.udp.ports[].s	String
services[].protocols.icmpv4	Object \|\| null
services[].protocols.icmpv4.types	Number[]
services[].protocols.icmpv6	Object \|\| null
services[].protocols.icmpv6.types	Number[]

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

'{
    "name": "svc-3",
    "protocols": {
        "tcp": null,
        "udp": null,
        "icmpv4": {
            "types": [
                3,
                11,
                22,
                254,
                255
            ]
        },
        "icmpv6": {
            "types": [
                0,
                9,
                111,
                222,
                253
            ]
        }
    },
    "sgNames": [
        "sg-0",
        "sg-1"
    ]
}'

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

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

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

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

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

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

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