Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Virtual Private Cloud
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Облачная сеть
      • Создать облачную сеть
      • Удалить облачную сеть
      • Изменить облачную сеть
    • Подсеть
      • Создать подсеть
      • Удалить подсеть
      • Изменить подсеть
    • IP-адрес
      • Зарезервировать статический публичный IP-адрес
      • Сделать динамический публичный IP-адрес статическим
      • Сделать статический публичный IP-адрес динамическим
      • Удалить статический публичный IP-адрес
    • Статическая маршрутизация
      • Создать статический маршрут
      • Включить NAT в интернет
    • Группы безопасности
      • Создать группу безопасности
      • Изменить группу безопасности и правила
      • Удалить группу безопасности
    • Защита от DDoS-атак
      • Включить защиту от DDoS-атак
  • Сценарии использования
    • Архитектура и защита базового интернет-сервиса
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Облачные сети и подсети
    • Адреса облачных ресурсов
    • Статические маршруты
    • Группы безопасности
    • MTU и MSS
    • Настройки DHCP
    • Квоты и лимиты
  • DDoS Protection
  • Cloud Interconnect
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
  • Справочник API
    • Аутентификация в API
    • REST
      • Обзор
      • Address
        • Обзор
        • create
        • delete
        • get
        • getByValue
        • list
        • listOperations
        • update
      • Network
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • listSubnets
        • update
      • RouteTable
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Subnet
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Operation
        • Обзор
        • get
    • gRPC
      • Обзор
      • AddressService
      • NetworkService
      • RouteTableService
      • SubnetService
      • OperationService
  • Вопросы и ответы
  1. Справочник API
  2. REST
  3. Address
  4. list

Метод list

  • HTTP-запрос
  • Query-параметры
  • Ответ

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

HTTP-запрос

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

{
  "addresses": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "reserved": true,
      "used": true,
      "externalIpv4Address": {
        "address": "string",
        "zoneId": "string",
        "requirements": {
          "ddosProtectionProvider": "string",
          "outgoingSmtpCapability": "string"
        }
      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
addresses[] object

Ресурс Адрес. Подробнее см. документацию.

addresses[].
id
string

Идентификатор адреса. Генерируется при создании.

addresses[].
folderId
string

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

addresses[].
createdAt
string (date-time)

Время создания ресурса.

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

addresses[].
name
string

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

addresses[].
description
string

Описание адреса.

addresses[].
labels
object

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

addresses[].
reserved
boolean (boolean)

Определяет, зарезервирован ли адрес (статический ли он).

addresses[].
used
boolean (boolean)

Определяет, используется ли адрес.

addresses[].
externalIpv4Address
object
addresses[].
externalIpv4Address.
address
string

Значение адреса.

addresses[].
externalIpv4Address.
zoneId
string

Зона доступности, из которой будет выделен адрес.

addresses[].
externalIpv4Address.
requirements
object

Параметры выделяемого адреса, например защита от DDoS-атак.

addresses[].
externalIpv4Address.
requirements.
ddosProtectionProvider
string

Идентификатор провайдера защиты от DDoS-атак.

addresses[].
externalIpv4Address.
requirements.
outgoingSmtpCapability
string

Возможность отправки SMTP-трафика.

nextPageToken string

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

Каждая следующая страница будет иметь свой next_page_token для продолжения перебора страниц результатов.

В этой статье:
  • HTTP-запрос
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»