Метод listSubnets

Возвращает список доступных подсетей в указанной облачной сети.

HTTP-запрос

GET https://vpc.api.cloud.yandex.net/vpc/v1/networks/{networkId}/subnets

Path-параметры

Параметр Описание
networkId Обязательное поле. Идентификатор ресурса Network для получения списка подсетей. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

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

Ресурс Subnet. Подробнее см. Subnets.

subnets[].
id
string

Идентификатор подсети.

subnets[].
folderId
string

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

subnets[].
createdAt
string (date-time)

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

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

subnets[].
name
string

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

subnets[].
description
string

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

subnets[].
labels
object

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

subnets[].
networkId
string

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

subnets[].
zoneId
string

Идентификатор зоны доступности, где находится подсеть.

subnets[].
v4CidrBlocks[]
string

CIDR. Диапазон внутренних адресов, определенных для этой подсети. Это поле может быть задано только во время создания ресурса Subnet и не может быть изменено. Например, 10.0.0.0/22 или 192.168.0.0/24. Минимальный размер подсети /28, максимальный размер подсети /16.

subnets[].
v6CidrBlocks[]
string

IPv6 еще не доступен.

nextPageToken string

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