Подключиться
Yandex Cloud Functions

Метод 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`
    "timer": {
      "cronExpression": "string",
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string"
      }
    },
    "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"
        }
      }
    },
    "objectStorage": {
      "eventType": [
        "string"
      ],
      "bucketId": "string",
      "prefix": "string",
      "suffix": "string",
      "invokeFunction": {
        "functionId": "string",
        "functionTag": "string",
        "serviceAccountId": "string",
        "retrySettings": {
          "retryAttempts": "string",
          "interval": "string"
        }
      }
    },
    // конец списка возможных полей`rule`

  }
}

Триггер для вызова бессерверной функции. Дополнительные сведения см. в разделе
Триггеры.

Поле Описание
id string

Идентификатор триггера. Генерируется во время создания.
folderId string

Обязательное поле. Идентификатор каталога, в котором создается триггер.

Максимальная длина строки в символах — 50.
createdAt string (date-time)

Время создания триггера.

Строка в формате RFC3339.
name string

Имя триггера.

Длина строки в символах должна быть от 3 до 63.
description string

Описание триггера.

Длина строки в символах должна быть от 0 до 256.
labels object

Метки триггеров в виде пар key:value .
rule object

Обязательное поле. Правило активации триггера (всегда соответствует типу триггера).

Описание правила активации триггера.
rule.
timer		 object
Правило для таймера.
rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage

Правило активации для таймера.
rule.
timer.
cronExpression		 string

Обязательное поле. Описание расписания в виде cron-выражения.

Максимальная длина строки в символах — 100.
rule.
timer.
invokeFunction		 object
Инструкции для вызова функции один раз.

Единичный вызов функции.
rule.
timer.
invokeFunction.
functionId		 string

Обязательное поле. Идентификатор вызываемой функции.

Максимальная длина строки в символах — 50.
rule.
timer.
invokeFunction.
functionTag		 string

Тег версии функции для выполнения.
rule.
timer.
invokeFunction.
serviceAccountId		 string

Идентификатор сервисного аккаунта, от имени которого будет вызываться функция.
rule.
messageQueue		 object
Правило для триггера очереди сообщений.
rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage

Правило для активации триггера очереди сообщений.
rule.
messageQueue.
queueId		 string

Обязательное поле. Идентификатор очереди сообщений в Yandex Message Queue.
rule.
messageQueue.
serviceAccountId		 string

Обязательное поле. Идентификатор сервисного аккаунта с ролью на чтение очереди сообщений.

Максимальная длина строки в символах — 50.
rule.
messageQueue.
batchSettings		 object
Обязательное поле. Настройки группы сообщений для обработки сообщений в очереди.

Настройки обработки группы сообщений в очереди.
rule.
messageQueue.
batchSettings.
size		 string (int64)

Размер группы сообщений. Триггер отправит группу сообщений в соответствующую функцию, когда число сообщений в очереди достигнет этого значения, или прошло cutoff время.

Допустимые значения — от 0 до 10 включительно.
rule.
messageQueue.
batchSettings.
cutoff		 string

Обязательное поле. Максимальное время ожидания. Триггер отправит группу сообщений, если время с момента последнего пакета превышает cutoff значение, независимо от количества сообщений в очереди.
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

Правило для активации триггера 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.
objectStorage		 object
rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage
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

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