Метод GetDedicatedIp

Статья создана

Возвращает информацию о выделенном IP-адресе в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.

Запрос

GET /v2/email/dedicated-ips/{IP} HTTP/2

Параметр

Описание

IP

Тип: string.

Выделенный IP-адрес.

Используйте в запросе общие заголовки.

{
  "DedicatedIp": {
    "Ip": "<IP-адрес>",
    "WarmupStatus": "DONE",
    "WarmupPercentage": 100,
    "PoolName": "<имя_пула>"
  }
}

Параметр	Описание
`Ip`	Тип: string. Выделенный IP-адрес.
`WarmupStatus`	Тип: string. Статус прогрева IP-адреса. Всегда возвращается значение `DONE`.
`WarmupPercentage`	Тип: integer. Процент завершения прогрева IP-адреса. Всегда возвращается значение `100`.
`PoolName`	Тип: string. Имя пула, в котором находится IP-адрес.

Ответ 200 OK может содержать дополнительные параметры. Он не возвращается строго в формате, указанном выше.

Для всех ошибок тело ответа представлено в одинаковом формате:

{
   "Code": "<название_ошибки>",
   "message": "<пояснение_к_ошибке>"
}

Название ошибки заимствуется из ее кода, например BadRequestException.

Возможные ошибки:

Код ошибки	Описание
`400 BadRequestException`	В запросе неправильно указаны заголовки или параметры, либо значение параметра `IP` не является корректным IP-адресом.
`404 NotFoundException`	IP-адрес не найден или не принадлежит вашему облаку.
`429 TooManyRequestsException`	При вызове запроса превышена квота.