Метод GetDedicatedIp
Возвращает информацию о выделенном IP-адресе в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
GET /v2/email/dedicated-ips/{IP} HTTP/2
Path-параметры
|
Параметр |
Описание |
|
|
Тип: string. Выделенный IP-адрес. |
Заголовки запроса
Используйте в запросе общие заголовки.
Ответы
200 OK
{
"DedicatedIp": {
"Ip": "<IP-адрес>",
"WarmupStatus": "DONE",
"WarmupPercentage": 100,
"PoolName": "<имя_пула>"
}
}
|
Параметр |
Описание |
|
|
Тип: string. Выделенный IP-адрес. |
|
|
Тип: string. Статус прогрева IP-адреса. Всегда возвращается значение |
|
|
Тип: integer. Процент завершения прогрева IP-адреса. Всегда возвращается значение |
|
|
Тип: string. Имя пула, в котором находится IP-адрес. |
Ответ 200 OK может содержать дополнительные параметры. Он не возвращается строго в формате, указанном выше.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе неправильно указаны заголовки или параметры, либо значение параметра |
|
|
IP-адрес не найден или не принадлежит вашему облаку. |
|
|
При вызове запроса превышена квота. |