Yandex Cloud
Документация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex Cloud Postbox
RU
  • Начало работы
  • Управление доступом
  • Правила тарификации
    • Аутентификация в API
    • Как пользоваться API
    • Подписывание запросов
      • Все методы
      • Отправка писем
      • Массовая отправка писем
        • Метод ListSuppressedDestinations
        • Метод GetSuppressedDestination
        • Метод PutSuppressedDestination
        • Метод DeleteSuppressedDestination
      • Заголовки запросов
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Вопросы и ответы

В этой статье:

  • Запрос
  • Query-параметры
  • Заголовки запроса
  • Ответы
  • 200 OK
  • Ошибки
  1. Справочник API
  2. REST
  3. Стоп-лист
  4. Метод ListSuppressedDestinations

Метод ListSuppressedDestinations

Статья создана
Yandex Cloud
Обновлена 27 августа 2026 г.
Открыть в Markdown
  • Запрос
    • Query-параметры
    • Заголовки запроса
  • Ответы
    • 200 OK
    • Ошибки

Возвращает список адресов в пользовательском стоп-листе. Нужное облако определяется по сервисному аккаунту, от имени которого выполняется запрос.

ЗапросЗапрос

GET /v2/email/suppression/addresses HTTP/2

Query-параметрыQuery-параметры

Параметр

Описание

PageSize

Тип: integer.

Максимальное число результатов, которое может быть на одной странице в ответе на запрос. Значение по умолчанию — 100, максимально допустимое — 1000. Если передать значение больше 1000, будет использовано значение 1000. Отрицательное значение приводит к ошибке.

NextToken

Тип: string.

Токен позволяет получить следующую страницу результатов запроса. Для этого передайте значение параметра NextToken, который вернулся в ответе на предыдущий запрос. Значение токена нельзя разбирать или составлять вручную.

Reason

Тип: string.

Причина добавления адреса в стоп-лист: BOUNCE или COMPLAINT. Параметр можно указать несколько раз. Если параметр не указан, возвращаются адреса со всеми причинами.

StartDate

Тип: string.

Нижняя граница времени последнего изменения записи, включительно.

EndDate

Тип: string.

Верхняя граница времени последнего изменения записи, включительно.

Даты указываются в формате RFC 3339 (2026-01-01T00:00:00Z) либо как время в секундах в формате Unix. Допустимый диапазон дат — с 1 января 1970 года по 31 декабря 2105 года. Значение StartDate не может быть больше значения EndDate.

Заголовки запросаЗаголовки запроса

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

ОтветыОтветы

200 OK200 OK

{
   "SuppressedDestinationSummaries": [
      {
         "EmailAddress": "user@example.com",
         "Reason": "COMPLAINT",
         "LastUpdateTime": 1586552585.000
      }
   ],
   "NextToken": "<токен>"
}

Параметр

Описание

SuppressedDestinationSummaries

Тип: array.

Массив адресов в стоп-листе. Записи отсортированы от недавно измененных к более старым.

EmailAddress

Тип: string.

Адрес получателя.

Reason

Тип: string.

Причина добавления адреса в стоп-лист: BOUNCE или COMPLAINT.

LastUpdateTime

Тип: number.

Время последнего изменения записи в секундах в формате Unix.

NextToken

Тип: string.

Токен позволяет получить следующую страницу результатов запроса. Возвращается, только если страница заполнена целиком. Пустое значение означает, что данные закончились.

ОшибкиОшибки

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

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

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

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

Код ошибки

Описание

400 BadRequestException

В запросе неправильно указаны заголовки или параметры: некорректный токен NextToken, отрицательное значение PageSize, недопустимые или противоречащие друг другу значения StartDate и EndDate.

403

Недостаточно прав для выполнения запроса.

429 TooManyRequestsException

При вызове запроса превышена квота.

Была ли статья полезна?

Предыдущая
Метод PutConfigurationSetVdmOptions
Следующая
Метод GetSuppressedDestination
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»