POST /v2/list-hosts

Этот метод отображает список хостов (Hosts) и их IP, в соответствии с указанным списком имен или UUID хостов (Hosts).

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

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

• byUuid.UIDs[] - Массив/Список uuid хостов.
• bySgName.names[] - Массив/Список имен Security Group(s).
• byHostname.names[] - Массив/Список имен хостов.

название	обязательность	тип данных	Значение по умолчанию
				hosts[]	да	Object[]

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

curl '127.0.0.1:9006/v2/list-hosts' \
--header 'Content-Type: application/json' \
--data '{
    "byUuid": {
      "UIDs": [
        "bd7f0c2e-1a0b-4ad0-9c52-1f1b3a7c2c11",
        "bd7f0c2e-1a0b-4ad0-9c52-1f1b3a7c2c12"
      ]
    }
  }'

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

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

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

curl '127.0.0.1:9006/v2/list-hosts' \
--header 'Content-Type: application/json' \
--data '{
    "byHostname": {
      "names": ["sg-example2", "sg-example3"]
    }
  }'

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

• hosts[] - Структура, содержащая описание создаваемых правил.
• hosts[].name - Имя хоста.
• hosts[].uuid - Уникальный идентификатор ресурса в формате UUID.
• hosts[].sgName - Security Group, с которой устанавливаются правила взаимодействия.
• hosts[].ipList.IPs - Массив/Список подсетей типа IP.

название	тип данных
hosts[]	Object[]
hosts[].name	String
hosts[].uuid	String
hosts[].sgName	String
hosts[].ipList.IPs	Array

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

{
  "hosts": [
    {
      "name": "to-nft-agent-7g5dt",
      "uuid": "36ef9838-ee3c-4876-bd8b-0a73568f524b",
      "sgName": "",
      "ipList": {
        "IPs": [
          "127.0.0.1",
          "::1",
          "fe80::68ba:e5ff:fe4e:76d0",
          "10.244.0.1"
        ]
      }
    }
  ]
}

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

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

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

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

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

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