Метод list
Возвращает список TargetGroup ресурсов в указанном каталоге..
HTTP-запрос
GET https://load-balancer.api.cloud.yandex.net/load-balancer/v1/targetGroups
Query-параметры
Параметр | Описание |
---|---|
folderId | Обязательное поле. Идентификатор каталога для вывода списка целевых групп. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50. |
pageSize | Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken, прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю TargetGroup.name. 2. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9] . Максимальная длина строки в символах — 1000. |
Ответ
HTTP Code: 200 - OK
{
"targetGroups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"regionId": "string",
"targets": [
{
"subnetId": "string",
"address": "string"
}
]
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
targetGroups[] | object Ресурс TargetGroup. Подробнее см. в разделе Целевые группы и ресурсы. |
targetGroups[]. id |
string Только для вывода. Идентификатор целевой группы. |
targetGroups[]. folderId |
string Идентификатор каталога, которому принадлежит целевая группа. |
targetGroups[]. createdAt |
string (date-time) Только для вывода. Время создания ресурса в формате RFC3339 . Строка в формате RFC3339. |
targetGroups[]. name |
string Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. |
targetGroups[]. description |
string Описание целевой группы. Длина 0-256 символов. |
targetGroups[]. labels |
object Метки ресурса в формате |
targetGroups[]. regionId |
string Идентификатор региона, в котором находится целевая группа. |
targetGroups[]. targets[] |
object Ресурс Target. Подробнее см. в разделе Целевые группы и ресурсы. |
targetGroups[]. targets[]. subnetId |
string Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50. |
targetGroups[]. targets[]. address |
string IP-адрес целевого ресурса. |
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken, для перебора страниц результатов. |