Метод get
Возвращает указанный триггер.
Чтобы получить список доступных триггеров, используйте запрос list .
HTTP-запрос
GET https://serverless-triggers.api.cloud.yandex.net/triggers/v1/triggers/{triggerId}
Path-параметры
Параметр | Описание |
---|---|
triggerId | Обязательное поле. Идентификатор возвращаемого триггера. Чтобы получить идентификатор триггера, используйте запрос list . |
Ответ
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"rule": {
// `rule` включает только одно из полей `timer`, `messageQueue`, `iotMessage`, `objectStorage`, `containerRegistry`, `cloudLogs`
"timer": {
"cronExpression": "string",
// `rule.timer` включает только одно из полей `invokeFunction`, `invokeFunctionWithRetry`
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string"
},
"invokeFunctionWithRetry": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
},
// конец списка возможных полей`rule.timer`
},
"messageQueue": {
"queueId": "string",
"serviceAccountId": "string",
"batchSettings": {
"size": "string",
"cutoff": "string"
},
"visibilityTimeout": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string"
}
},
"iotMessage": {
"registryId": "string",
"deviceId": "string",
"mqttTopic": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
"objectStorage": {
"eventType": [
"string"
],
"bucketId": "string",
"prefix": "string",
"suffix": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
"containerRegistry": {
"eventType": [
"string"
],
"registryId": "string",
"imageName": "string",
"tag": "string",
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
"cloudLogs": {
"logGroupId": [
"string"
],
"batchSettings": {
"size": "string",
"cutoff": "string"
},
"invokeFunction": {
"functionId": "string",
"functionTag": "string",
"serviceAccountId": "string",
"retrySettings": {
"retryAttempts": "string",
"interval": "string"
},
"deadLetterQueue": {
"queueId": "string",
"serviceAccountId": "string"
}
}
},
// конец списка возможных полей`rule`
},
"status": "string"
}
Триггер для вызова бессерверной функции. Дополнительные сведения см. в разделе Triggers.
Поле | Описание |
---|---|
id | string Идентификатор триггера. Генерируется при создании. |
folderId | string Обязательное поле. Идентификатор каталога, в котором создается триггер. Максимальная длина строки в символах — 50. |
createdAt | string (date-time) Время создания триггера. Строка в формате RFC3339. |
name | string Имя триггера. Длина строки в символах должна быть от 3 до 63. |
description | string Описание триггера. Длина строки в символах должна быть от 0 до 256. |
labels | object Метки триггеров в виде пар |
rule | object Обязательное поле. Правило активации триггера (всегда соответствует типу триггера). Описание правила активации триггера. |
rule. timer |
object Правило для таймера. rule включает только одно из полей timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs Правило активации таймера. |
rule. timer. cronExpression |
string Обязательное поле. Описание расписания в виде cron expression. Максимальная длина строки в символах — 100. |
rule. timer. invokeFunction |
object Инструкции для единичного вызова функции. rule.timer включает только одно из полей invokeFunction , invokeFunctionWithRetry Единичный вызов функции. |
rule. timer. invokeFunction. functionId |
string Обязательное поле. Идентификатор вызываемой функции. Максимальная длина строки в символах — 50. |
rule. timer. invokeFunction. functionTag |
string Тег версии выполняемой функции. |
rule. timer. invokeFunction. serviceAccountId |
string Идентификатор сервисного аккаунта, от имени которого будет вызываться функция. |
rule. timer. invokeFunctionWithRetry |
object Инструкции для вызова функции с повторными попытками по мере необходимости. rule.timer включает только одно из полей invokeFunction , invokeFunctionWithRetry Вызов функции с повторными попытками. |
rule. timer. invokeFunctionWithRetry. functionId |
string Обязательное поле. Идентификатор вызываемой функции. Максимальная длина строки в символах — 50. |
rule. timer. invokeFunctionWithRetry. functionTag |
string Тег версии выполняемой функции. |
rule. timer. invokeFunctionWithRetry. serviceAccountId |
string Идентификатор сервисного аккаунта с правами на вызов функции. |
rule. timer. invokeFunctionWithRetry. retrySettings |
object Политика повторных попыток. Если поле не указано или значение пусто, повторные попытки не предпринимаются. Параметры повторной попытки вызова функции. |
rule. timer. invokeFunctionWithRetry. retrySettings. retryAttempts |
string (int64) Максимальное количество повторных попыток (дополнительных вызовов), прежде чем действие будет считаться неудачным. Допустимые значения — от 1 до 5 включительно. |
rule. timer. invokeFunctionWithRetry. retrySettings. interval |
string Обязательное поле. Время ожидания между повторными попытками, в секундах. |
rule. timer. invokeFunctionWithRetry. deadLetterQueue |
object Политика DLQ (отсутствие значения означает отказ от сообщения). |
rule. timer. invokeFunctionWithRetry. deadLetterQueue. queueId |
string Идентификатор очереди. |
rule. timer. invokeFunctionWithRetry. deadLetterQueue. serviceAccountId |
string Обязательное поле. Сервисный аккаунт с правами на запись в очередь. Максимальная длина строки в символах — 50. |
rule. messageQueue |
object Правило для триггера очереди сообщений. rule включает только одно из полей timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs Правило для активации триггера очереди сообщений. |
rule. messageQueue. queueId |
string Обязательное поле. Идентификатор очереди сообщений в Yandex Message Queue. |
rule. messageQueue. serviceAccountId |
string Обязательное поле. Идентификатор сервисного аккаунта с ролью на чтение очереди сообщений. Максимальная длина строки в символах — 50. |
rule. messageQueue. batchSettings |
object Обязательное поле. Настройки группы сообщений для обработки сообщений в очереди. Настройки обработки группы сообщений в очереди. |
rule. messageQueue. batchSettings. size |
string (int64) Размер группы сообщений. Триггер отправит группу сообщений в функцию, когда число сообщений в очереди достигнет Допустимые значения — от 0 до 10 включительно. |
rule. messageQueue. batchSettings. cutoff |
string Обязательное поле. Максимальное время ожидания. Триггер отправит группу сообщений в функцию, когда число сообщений в очереди достигнет |
rule. messageQueue. visibilityTimeout |
string Переопределение таймаута видимости очереди. Максимальное значение — 43200 seconds. |
rule. messageQueue. invokeFunction |
object Инструкции для единичного вызова функции. Единичный вызов функции. |
rule. messageQueue. invokeFunction. functionId |
string Обязательное поле. Идентификатор вызываемой функции. Максимальная длина строки в символах — 50. |
rule. messageQueue. invokeFunction. functionTag |
string Тег версии выполняемой функции. |
rule. messageQueue. invokeFunction. serviceAccountId |
string Идентификатор сервисного аккаунта, от имени которого будет вызываться функция. |
rule. iotMessage |
object Правило для триггера Yandex IoT Core. rule включает только одно из полей timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs Правило для активации триггера Yandex IoT Core. |
rule. iotMessage. registryId |
string Обязательное поле. Идентификатор реестра Yandex IoT Core. |
rule. iotMessage. deviceId |
string Идентификатор устройства в реестре Yandex IoT. |
rule. iotMessage. mqttTopic |
string MQTT-топик, сообщения котрого активируют триггер. |
rule. iotMessage. invokeFunction |
object Инструкции для вызова функции с повторными попытками по мере необходимости. Вызов функции с повторными попытками. |
rule. iotMessage. invokeFunction. functionId |
string Обязательное поле. Идентификатор вызываемой функции. Максимальная длина строки в символах — 50. |
rule. iotMessage. invokeFunction. functionTag |
string Тег версии выполняемой функции. |
rule. iotMessage. invokeFunction. serviceAccountId |
string Идентификатор сервисного аккаунта с правами на вызов функции. |
rule. iotMessage. invokeFunction. retrySettings |
object Политика повторных попыток. Если поле не указано или значение пусто, повторные попытки не предпринимаются. Параметры повторной попытки вызова функции. |
rule. iotMessage. invokeFunction. retrySettings. retryAttempts |
string (int64) Максимальное количество повторных попыток (дополнительных вызовов), прежде чем действие будет считаться неудачным. Допустимые значения — от 1 до 5 включительно. |
rule. iotMessage. invokeFunction. retrySettings. interval |
string Обязательное поле. Время ожидания между повторными попытками, в секундах. |
rule. iotMessage. invokeFunction. deadLetterQueue |
object Политика DLQ (отсутствие значения означает отказ от сообщения). |
rule. iotMessage. invokeFunction. deadLetterQueue. queueId |
string Идентификатор очереди. |
rule. iotMessage. invokeFunction. deadLetterQueue. serviceAccountId |
string Обязательное поле. Сервисный аккаунт с правами на запись в очередь. Максимальная длина строки в символах — 50. |
rule. objectStorage |
object rule включает только одно из полей timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs |
rule. objectStorage. eventType[] |
string Обязательное поле. Тип (имя) событий, требуется хотя бы одно значение. Должен содержать хотя бы один элемент. |
rule. objectStorage. bucketId |
string Идентификатор бакета. |
rule. objectStorage. prefix |
string Префикс ключа объекта. Фильтр, опционально. |
rule. objectStorage. suffix |
string Суффикс ключа объекта. Фильтр, опционально. |
rule. objectStorage. invokeFunction |
object Инструкции для вызова функции с повторными попытками по мере необходимости. Вызов функции с повторными попытками. |
rule. objectStorage. invokeFunction. functionId |
string Обязательное поле. Идентификатор вызываемой функции. Максимальная длина строки в символах — 50. |
rule. objectStorage. invokeFunction. functionTag |
string Тег версии выполняемой функции. |
rule. objectStorage. invokeFunction. serviceAccountId |
string Идентификатор сервисного аккаунта с правами на вызов функции. |
rule. objectStorage. invokeFunction. retrySettings |
object Политика повторных попыток. Если поле не указано или значение пусто, повторные попытки не предпринимаются. Параметры повторной попытки вызова функции. |
rule. objectStorage. invokeFunction. retrySettings. retryAttempts |
string (int64) Максимальное количество повторных попыток (дополнительных вызовов), прежде чем действие будет считаться неудачным. Допустимые значения — от 1 до 5 включительно. |
rule. objectStorage. invokeFunction. retrySettings. interval |
string Обязательное поле. Время ожидания между повторными попытками, в секундах. |
rule. objectStorage. invokeFunction. deadLetterQueue |
object Политика DLQ (отсутствие значения означает отказ от сообщения). |
rule. objectStorage. invokeFunction. deadLetterQueue. queueId |
string Идентификатор очереди. |
rule. objectStorage. invokeFunction. deadLetterQueue. serviceAccountId |
string Обязательное поле. Сервисный аккаунт с правами на запись в очередь. Максимальная длина строки в символах — 50. |
rule. containerRegistry |
object rule включает только одно из полей timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs |
rule. containerRegistry. eventType[] |
string Обязательное поле. Тип (имя) событий, требуется хотя бы одно значение. Должен содержать хотя бы один элемент. |
rule. containerRegistry. registryId |
string Идентификатор реестра. |
rule. containerRegistry. imageName |
string Имя Docker-образа. Фильтр, опционально. |
rule. containerRegistry. tag |
string Тег Docker-образа. Фильтр, опционально. |
rule. containerRegistry. invokeFunction |
object Инструкции для вызова функции с повторными попытками по мере необходимости. Вызов функции с повторными попытками. |
rule. containerRegistry. invokeFunction. functionId |
string Обязательное поле. Идентификатор вызываемой функции. Максимальная длина строки в символах — 50. |
rule. containerRegistry. invokeFunction. functionTag |
string Тег версии выполняемой функции. |
rule. containerRegistry. invokeFunction. serviceAccountId |
string Идентификатор сервисного аккаунта с правами на вызов функции. |
rule. containerRegistry. invokeFunction. retrySettings |
object Политика повторных попыток. Если поле не указано или значение пусто, повторные попытки не предпринимаются. Параметры повторной попытки вызова функции. |
rule. containerRegistry. invokeFunction. retrySettings. retryAttempts |
string (int64) Максимальное количество повторных попыток (дополнительных вызовов), прежде чем действие будет считаться неудачным. Допустимые значения — от 1 до 5 включительно. |
rule. containerRegistry. invokeFunction. retrySettings. interval |
string Обязательное поле. Время ожидания между повторными попытками, в секундах. |
rule. containerRegistry. invokeFunction. deadLetterQueue |
object Политика DLQ (отсутствие значения означает отказ от сообщения). |
rule. containerRegistry. invokeFunction. deadLetterQueue. queueId |
string Идентификатор очереди. |
rule. containerRegistry. invokeFunction. deadLetterQueue. serviceAccountId |
string Обязательное поле. Сервисный аккаунт с правами на запись в очередь. Максимальная длина строки в символах — 50. |
rule. cloudLogs |
object rule включает только одно из полей timer , messageQueue , iotMessage , objectStorage , containerRegistry , cloudLogs |
rule. cloudLogs. logGroupId[] |
string Идентификаторы групп журналов, по крайней мере, одно значение обязательно. |
rule. cloudLogs. batchSettings |
object Обязательное поле. Пакетные настройки для обработки событий журнала. |
rule. cloudLogs. batchSettings. size |
string (int64) Размер группы сообщений. Триггер отправит группу сообщений в функцию, когда число сообщений в лог-группе достигнет Допустимые значения — от 0 до 100 включительно. |
rule. cloudLogs. batchSettings. cutoff |
string Максимальное время ожидания. Триггер отправит группу сообщений в функцию, когда число сообщений в лог-группе достигнет Допустимые значения — от 1 seconds до 60 seconds включительно. |
rule. cloudLogs. invokeFunction |
object Инструкции для вызова функции с повторными попытками по мере необходимости. Вызов функции с повторными попытками. |
rule. cloudLogs. invokeFunction. functionId |
string Обязательное поле. Идентификатор вызываемой функции. Максимальная длина строки в символах — 50. |
rule. cloudLogs. invokeFunction. functionTag |
string Тег версии выполняемой функции. |
rule. cloudLogs. invokeFunction. serviceAccountId |
string Идентификатор сервисного аккаунта с правами на вызов функции. |
rule. cloudLogs. invokeFunction. retrySettings |
object Политика повторных попыток. Если поле не указано или значение пусто, повторные попытки не предпринимаются. Параметры повторной попытки вызова функции. |
rule. cloudLogs. invokeFunction. retrySettings. retryAttempts |
string (int64) Максимальное количество повторных попыток (дополнительных вызовов), прежде чем действие будет считаться неудачным. Допустимые значения — от 1 до 5 включительно. |
rule. cloudLogs. invokeFunction. retrySettings. interval |
string Обязательное поле. Время ожидания между повторными попытками, в секундах. |
rule. cloudLogs. invokeFunction. deadLetterQueue |
object Политика DLQ (отсутствие значения означает отказ от сообщения). |
rule. cloudLogs. invokeFunction. deadLetterQueue. queueId |
string Идентификатор очереди. |
rule. cloudLogs. invokeFunction. deadLetterQueue. serviceAccountId |
string Обязательное поле. Сервисный аккаунт с правами на запись в очередь. Максимальная длина строки в символах — 50. |
status | string Состояние триггера |