Метод list
Возвращает список доступных групп выделенных хостов в указанном каталоге.
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 Политика обслуживания.
|
hostGroups[]. scalePolicy |
object Политика масштабирования. На данный момент поддерживается только фиксированное количество выделенных хостов. |
hostGroups[]. scalePolicy. fixedScale |
object |
hostGroups[]. scalePolicy. fixedScale. size |
string (int64) |
nextPageToken | string Этот токен позволяет получить следующую страницу результатов для списка запросов. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Каждая следующая страница будет иметь свой nextPageToken для продолжения перебора страниц результатов. |