Метод get

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

Возвращает информацию об указанном адресе.

Чтобы получить список доступных адресов, используйте запрос list.

HTTP-запрос

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

Path-параметры

Параметр	Описание
addressId	Обязательное поле. Идентификатор возвращаемого адреса. Чтобы получить идентификатор адреса, используйте запрос list. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

{
  "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"
    }
  }
}

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

Поле	Описание
id	string Идентификатор адреса. Генерируется при создании.
folderId	string Идентификатор каталога, которому принадлежит адрес.
createdAt	string (date-time) Время создания ресурса. Строка в формате RFC3339.
name	string Имя адреса. Имя должно быть уникальным в каталоге.
description	string Описание адреса.
labels	object Метки адреса в формате `ключ:значение`.
reserved	boolean (boolean) Определяет, зарезервирован ли адрес (статический ли он).
used	boolean (boolean) Определяет, используется ли адрес.
externalIpv4Address	object
externalIpv4Address. address	string Значение адреса.
externalIpv4Address. zoneId	string Зона доступности, из которой будет выделен адрес.
externalIpv4Address. requirements	object Параметры выделяемого адреса, например защита от DDoS-атак.
externalIpv4Address. requirements. ddosProtectionProvider	string Идентификатор провайдера защиты от DDoS-атак.
externalIpv4Address. requirements. outgoingSmtpCapability	string Возможность отправки SMTP-трафика.