Метод list
Возвращает список групп размещения в указанном каталоге.
HTTP-запрос
GET https://compute.api.cloud.yandex.net/compute/v1/placementGroups
Query-параметры
| Параметр | Описание |
|---|---|
| folderId | Идентификатор каталога для получения списка групп размещения. Чтобы получить идентификатор каталога, используйте запрос list. |
| pageSize | Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. |
| pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. |
| filter | Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю PlacementGroup.name. |
Ответ
HTTP Code: 200 - OK
{
"placementGroups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"spreadPlacementStrategy": {}
}
],
"nextPageToken": "string"
}
| Поле | Описание |
|---|---|
| placementGroups[] | object Выводит список групп размещения для указанного каталога. |
| placementGroups[]. id |
string Идентификатор группы размещения. Генерируется при создании. |
| placementGroups[]. folderId |
string Идентификатор каталога, которому принадлежит группа размещения. |
| placementGroups[]. createdAt |
string (date-time) Время создания ресурса. Строка в формате RFC3339. |
| placementGroups[]. name |
string Имя группы размещения. Имя уникально в рамках каталога. |
| placementGroups[]. description |
string Описание группы размещения. Длина описания должна быть от 0 до 256 символов. |
| placementGroups[]. labels |
object Метки групп размещения в формате |
| placementGroups[]. spreadPlacementStrategy |
object Стратегия распределенного размещения ( spread). Каждая из виртуальных машин в группе расположена на отдельной стойке.Это пустая структура, которую необходимо передать для явного указания стратегии размещения. |
| nextPageToken | string Токен для получения следующей страницы списка. Если количество результатов больше чем [ Каждая следующая страница будет иметь свой |