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