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. create

Метод create

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

Создает адрес в указанном каталоге и сети.

HTTP-запрос

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

Параметры в теле запроса

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "externalIpv4AddressSpec": {
    "address": "string",
    "zoneId": "string",
    "requirements": {
      "ddosProtectionProvider": "string",
      "outgoingSmtpCapability": "string"
    }
  }
}
Поле Описание
folderId string

Обязательное поле. Идентификатор каталога, в котором создается адрес.

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

Максимальная длина строки в символах — 50.

name string

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

Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].

description string

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

Максимальная длина строки в символах — 256.

labels object

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

Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*.

externalIpv4AddressSpec object
externalIpv4AddressSpec.
address
string

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

externalIpv4AddressSpec.
zoneId
string

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

externalIpv4AddressSpec.
requirements
object

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

externalIpv4AddressSpec.
requirements.
ddosProtectionProvider
string

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

externalIpv4AddressSpec.
requirements.
outgoingSmtpCapability
string

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

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле Описание
id string

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

description string

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

createdAt string (date-time)

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

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

createdBy string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.

modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

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

done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.

metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.

error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.

error.
code
integer (int32)

Код ошибки. Значение из списка google.rpc.Code.

error.
message
string

Текст ошибки.

error.
details[]
object

Список сообщений с подробными сведениями об ошибке.

response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

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