Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Compute Cloud
  • Начало работы
    • Обзор
    • Создание виртуальной машины Linux
    • Создание виртуальной машины Windows
    • Создание группы виртуальных машин
  • Пошаговые инструкции
    • Все инструкции
    • Создание виртуальной машины
      • Создать ВМ Linux
      • Создать ВМ Windows
      • Создать ВМ из набора дисков
      • Создать ВМ с дисками из снимков
      • Создать ВМ из пользовательского образа
      • Создать прерываемую ВМ
      • Создать ВМ c GPU
    • DSVM
      • Обзор
      • Создать ВМ из публичного образа DSVM
    • Группы размещения
      • Создать группу размещения
      • Удалить группу размещения
      • Создать ВМ в группе размещения
      • Добавить ВМ в группу размещения
      • Исключить ВМ из группы размещения
    • Образы с предустановленным ПО
      • Создать ВМ из публичного образа
      • Настроить ПО
      • Работа с ВМ на базе публичного образа
      • Получить список публичных образов
    • Получение информации о виртуальной машине
      • Получить информацию о ВМ
      • Получить вывод последовательного порта
    • Управление виртуальной машиной
      • Остановить и запустить ВМ
      • Подключить диск к ВМ
      • Отключить диск от ВМ
      • Перенести ВМ в другую зону доступности
      • Сделать публичный IP-адрес ВМ статическим
      • Изменить ВМ
      • Изменить вычислительные ресурсы ВМ
      • Удалить ВМ
    • Работа на виртуальной машине
      • Подключиться к ВМ по SSH
      • Подключиться к ВМ по RDP
      • Работа с Yandex.Cloud изнутри ВМ
      • Установить NVIDIA-драйверы
    • Создание нового диска
      • Создать пустой диcк
      • Создать пустой диск с блоком большого размера
    • Управление диском
      • Создать снимок диска
      • Изменить диск
      • Удалить диcк
      • Удалить снимок диска
    • Создание нового образа
      • Загрузить свой образ
    • Управление образом
      • Удалить образ
    • Управление серийной консолью
      • Начало работы
      • Подключиться к серийной консоли по SSH
      • Подключиться к серийной консоли с помощью CLI
      • Запустить командную оболочку в Windows SAC
      • Отключить доступ к серийной консоли
    • Создание группы виртуальных машин
      • Создать группу ВМ фиксированного размера
      • Создать группу ВМ фиксированного размера с сетевым балансировщиком
      • Создать автоматически масштабируемую группу ВМ
      • Создать группу ВМ с Container Optimized Image
    • Получение информации о группе виртуальных машин
      • Получить список групп ВМ
      • Получить информацию о группе ВМ
      • Получить список ВМ в группе
    • Управление группой виртуальных машин
      • Изменить группу ВМ
      • Настроить проверку состояния приложения на ВМ
      • Обновить группу
        • Постепенное обновление
        • Обновление без простоя
      • Остановить группу ВМ
      • Запустить группу ВМ
      • Удалить группу ВМ
    • Выделенные хосты
      • Создать ВМ в группе выделенных хостов
      • Создать ВМ на выделенном хосте
  • Yandex Container Solution
  • Сценарии использования
    • Настройка синхронизации времени NTP
    • Работа с группой ВМ с автоматическим масштабированием
  • Концепции
    • Взаимосвязь ресурсов
    • Виртуальные машины
      • Обзор
      • Платформы
      • Уровни производительности vCPU
      • Графические ускорители (GPU)
      • Прерываемые виртуальные машины
      • Сеть на виртуальной машине
      • Динамическая миграция
      • Группы размещения
      • Статусы
      • Метаданные
    • Диски
      • Обзор
      • Снимки дисков
    • Образы
    • Группы виртуальных машин
      • Обзор
      • Доступ
      • Шаблон виртуальной машины
      • Переменные в шаблоне виртуальной машины
      • Политики
        • Обзор
        • Политика распределения
        • Политика развертывания
        • Политика масштабирования
      • Типы масштабирования
      • Автоматическое восстановление
      • Обновление
        • Обзор
        • Распределение виртуальных машин по зонам
        • Алгоритм развертывания
        • Правила обновления виртуальных машин
      • Статусы
    • Выделенный хост
    • Резервное копирование
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
      • С 1 января до 1 марта 2019 года
      • С 1 марта до 1 мая 2019 года
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • DiskService
      • DiskTypeService
      • HostGroupService
      • HostTypeService
      • ImageService
      • InstanceService
      • PlacementGroupService
      • SnapshotService
      • ZoneService
      • InstanceGroupService
      • OperationService
    • REST
      • Обзор
      • Disk
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • DiskType
        • Обзор
        • get
        • list
      • HostGroup
        • Обзор
        • create
        • delete
        • get
        • list
        • listHosts
        • listInstances
        • listOperations
        • update
      • HostType
        • Обзор
        • get
        • list
      • Image
        • Обзор
        • create
        • delete
        • get
        • getLatestByFamily
        • list
        • listOperations
        • update
      • Instance
        • Обзор
        • attachDisk
        • create
        • delete
        • detachDisk
        • get
        • getSerialPortOutput
        • list
        • listOperations
        • restart
        • start
        • stop
        • update
        • updateMetadata
      • PlacementGroup
        • Обзор
        • create
        • delete
        • get
        • list
        • listInstances
        • listOperations
        • update
      • Snapshot
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Zone
        • Обзор
        • get
        • list
      • Operation
        • Обзор
        • get
      • InstanceGroup
        • Обзор
        • createFromYaml
        • update
        • list
        • get
        • delete
        • start
        • stop
        • create
        • updateFromYaml
        • listLogRecords
        • listInstances
        • listOperations
  • Вопросы и ответы
    • Общие вопросы
    • Виртуальные машины
    • Диски и снимки
    • Аварийное восстановление
    • Лицензирование
    • Все вопросы на одной странице
  1. Справочник API
  2. REST
  3. HostGroup
  4. list

Метод list

  • HTTP-запрос
  • Query-параметры
  • Ответ

Возвращает список доступных групп выделенных хостов в указанном каталоге.

HTTP-запрос

GET https://compute.api.cloud.yandex.net/compute/v1/hostGroups

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога, в котором созданы группы выделенных хостов. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Параметры фильтрации ресурса в ответе. В настоящее время фильтрация осуществляется только по полю HostGroup.name. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "hostGroups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "zoneId": "string",
      "status": "string",
      "typeId": "string",
      "maintenancePolicy": "string",
      "scalePolicy": {
        "fixedScale": {
          "size": "string"
        }
      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
hostGroups[] object

Описывает группу выделенных хостов.

hostGroups[].
id
string

Идентификатор группы выделенных хостов.

hostGroups[].
folderId
string

Идентификатор каталога, к которому принадлежит группа выделенных хостов.

hostGroups[].
createdAt
string (date-time)

Время создания группы выделенных хостов в текстовом формате RFC3339.

Строка в формате RFC3339.

hostGroups[].
name
string

Имя группы выделенных хостов. Имя должно быть уникальным в каталоге.

hostGroups[].
description
string

Описание группы выделенных хостов.

hostGroups[].
labels
object

Метки ресурса в формате ключ:значение.

hostGroups[].
zoneId
string

Зона доступности, в которой размещены все выделенные хосты.

hostGroups[].
status
string

Статус группы выделенных хостов.

hostGroups[].
typeId
string

Идентификатор типа выделенного хоста. Ресурсы, предоставляемые каждым выделенным хостом группы.

hostGroups[].
maintenancePolicy
string

Политика обслуживания.

  • RESTART: После обслуживания перезапустить ВМ на том же выделенном хосте.
  • MIGRATE: Перенести ВМ на другой выделенный хост перед обслуживанием.
hostGroups[].
scalePolicy
object

Политика масштабирования. На данный момент поддерживается только фиксированное количество выделенных хостов.

hostGroups[].
scalePolicy.
fixedScale
object
hostGroups[].
scalePolicy.
fixedScale.
size
string (int64)
nextPageToken string

Этот токен позволяет получить следующую страницу результатов для списка запросов. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Каждая следующая страница будет иметь свой nextPageToken для продолжения перебора страниц результатов.

В этой статье:
  • HTTP-запрос
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»