Метод GetConfigurationSetEventDestinations
Возвращает информацию о подписках для конфигурации в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
GET /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations HTTP/2
Path-параметры
|
Параметр |
Описание |
|
|
Тип: string. Название конфигурации. |
Заголовки запроса
Используйте в запросе общие заголовки.
Ответы
200 OK
{
"EventDestinations": [
{
"Name": "<название_подписки>",
"Enabled": <состояние_подписки>,
"KinesisFirehoseDestination": {
"DeliveryStreamArn": "<поток_данных>"
}
}
]
}
|
Параметр |
Описание |
|
|
Тип: array. Массив подписок. |
|
|
Тип: string. Название подписки. |
|
|
Тип: boolean. Состояние подписки: |
|
|
Тип: object. Объект, который определяет место назначения для отправки уведомлений. |
|
|
Тип: string. Поток данных Yandex Data Streams, в который отправляются уведомления. Формат: Пример
|
Ответ 200 OK может содержать дополнительные параметры. Он не возвращается строго в формате, указанном выше.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе переданы неправильные заголовки или параметры. |
|
|
Не найден запрашиваемый ресурс. |
|
|
При вызове запроса превышена квота. |