Метод get

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

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

HTTP-запрос

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

Path-параметры

Параметр	Описание
hostGroupId	Обязательное поле. Идентификатор группы выделенных хостов. Чтобы получить идентификатор группы выделенных хостов, используйте запрос list. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "zoneId": "string",
  "status": "string",
  "typeId": "string",
  "maintenancePolicy": "string",
  "scalePolicy": {
    "fixedScale": {
      "size": "string"
    }
  }
}

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

Поле	Описание
id	string Идентификатор группы выделенных хостов.
folderId	string Идентификатор каталога, к которому принадлежит группа выделенных хостов.
createdAt	string (date-time) Время создания группы выделенных хостов в текстовом формате RFC3339. Строка в формате RFC3339.
name	string Имя группы выделенных хостов. Имя должно быть уникальным в каталоге.
description	string Описание группы выделенных хостов.
labels	object Метки ресурса в формате `ключ:значение`.
zoneId	string Зона доступности, в которой размещены все выделенные хосты.
status	string Статус группы выделенных хостов.
typeId	string Идентификатор типа выделенного хоста. Ресурсы, предоставляемые каждым выделенным хостом группы.
maintenancePolicy	string Политика обслуживания. RESTART: После обслуживания перезапустить ВМ на том же выделенном хосте. MIGRATE: Перенести ВМ на другой выделенный хост перед обслуживанием.
scalePolicy	object Политика масштабирования. На данный момент поддерживается только фиксированное количество выделенных хостов.
scalePolicy. fixedScale	object
scalePolicy. fixedScale. size	string (int64)