POST /v2/list-hosts

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

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

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

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

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

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

curl '127.0.0.1:9006/v2/list-hosts' \
--header 'Content-Type: application/json' \
--data '{
    "byUUID": {
        "UUIDs": [
            "7e14ccc7-0891-460e-8e3b-79c8642c4f97",
            "eb5b7e27-d869-4516-827a-b353c1b35c3c"
        ]
    }
}'

Пример использования (поиск по 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": [
            "host-0",
            "host-1"
        ]
    }
}'

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

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

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

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

название	тип данных
hosts[]	Object[]
hosts[].host.name	String
hosts[].host.uuid	String
hosts[].host.sgName	String
hosts[].host.ipList.IPs	Array
hosts[].metaInfo	Object
hosts[].metaInfo.hostName	string
hosts[].metaInfo.os	string
hosts[].metaInfo.platform	string
hosts[].metaInfo.platformFamily	string
hosts[].metaInfo.platformVersion	string
hosts[].metaInfo.kernelVersion	string

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

{
    "hosts": [
        {
            "host": {
                "name": "host-10",
                "uuid": "08ff8294-4366-4c76-9f1c-06846cc3cdca",
                "sgName": "",
                "ipList": {
                    "IPs": []
                }
            },
            "metaInfo": {
                "hostName": "host-10",
                "os": "linux",
                "platform": "ubuntu",
                "platformFamily": "debiann",
                "platformVersion": "20.044",
                "kernelVersion": "5.15.0-139-genericc"
            }
        }
    ]
}

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

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