Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Cloud Postbox
  • Начало работы
  • Управление доступом
  • Правила тарификации
    • Аутентификация в API
    • Как пользоваться API
    • Подписывание запросов
      • Все методы
      • Отправка писем
        • Метод ListConfigurationSets
        • Метод GetConfigurationSet
        • Метод CreateConfigurationSet
        • Метод PutDomainIdentityConfigurationSetAttributes
        • Метод DeleteConfigurationSet
      • Заголовки запросов
  • Аудитные логи Audit Trails
  • История изменений

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

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

Метод ListConfigurationSets

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

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

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

GET /v2/email/configuration-sets HTTP/2

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

Параметр

Описание

PageSize

Тип: integer.

Максимальное число результатов, которое может быть на одной странице в ответе на запрос. Если число доступных результатов больше значения PageSize, в ответе на запрос возвращается токен NextToken для запроса следующей страницы результатов.

Максимально допустимое значение параметра — 1000.

NextToken

Тип: string.

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

Максимальная длина строки в параметре — 100 символов.

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

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

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

200 OK200 OK

{
   "ConfigurationSets": [
      "<название_конфигурации_1>",
      "<название_конфигурации_2>",
      ...
      "<название_конфигурации_N>"
   ],
   "NextToken": "<токен>"
}

Параметр

Описание

ConfigurationSets

Тип: array.

Массив из названий конфигураций. Каждое название представлено в виде отдельной строки.

NextToken

Тип: string.

Токен позволяет получить следующую страницу результатов запроса. Если число доступных результатов больше значения PageSize, в ответе на запрос возвращается токен NextToken для запроса следующей страницы результатов. Каждой странице присваивается свой токен для пагинации.

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

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

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

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

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

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

Код ошибки

Описание

400 BadRequestException

В запросе переданы неправильно составленные заголовки.

429 TooManyRequestsException

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

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

Предыдущая
Метод DeleteDomainIdentity
Следующая
Метод GetConfigurationSet
Проект Яндекса
© 2025 ООО «Яндекс.Облако»