Метод list

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

HTTP-запрос

GET https://vpc.api.cloud.yandex.net/vpc/v1/networks

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога для получения списка облачных сетей. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю Network.name. 2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "networks": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
networks[] object

Ресурс Network. Подробнее см. Networks.

networks[].
id
string

Идентификатор облачной сети.

networks[].
folderId
string

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

networks[].
createdAt
string (date-time)

Время создания ресурса в формате в RFC3339.

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

networks[].
name
string

Имя облачной сети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.

networks[].
description
string

Описание облачной сети. Длина описания должна быть от 0 до 256 символов.

networks[].
labels
object

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

nextPageToken string

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