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