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

Метод list

Возвращает список триггеров в указанном каталоге.

HTTP-запрос

GET https://serverless-triggers.api.cloud.yandex.net/triggers/v1/triggers

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога для получения списка триггеров. Чтобы получить идентификатор каталога, используйте запрос list.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов.
filter Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю Trigger.name. 2. Условный оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. Пример фильтра: name=my-trigger.

Ответ

HTTP Code: 200 - OK

{
  "triggers": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "rule": {

        // `triggers[].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"
            }
          }
        },
        // конец списка возможных полей`triggers[].rule`

      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
triggers[] object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Обязательное поле. Максимальное время ожидания. Триггер отправит группу сообщений, если время с момента последнего пакета превышает cutoff значение, независимо от количества сообщений в очереди.
triggers[].
rule.
messageQueue.
visibilityTimeout		 string

Переопределение таймаута видимости очереди.

Максимальное значение — 43200 seconds.
triggers[].
rule.
messageQueue.
invokeFunction		 object
Инструкции для вызова функции один раз.

Единичный вызов функции.
triggers[].
rule.
messageQueue.
invokeFunction.
functionId		 string

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

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

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

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

Правило для активации триггера Yandex IoT Core.
triggers[].
rule.
iotMessage.
registryId		 string

Обязательное поле. Идентификатор реестра Yandex IoT Core.
triggers[].
rule.
iotMessage.
deviceId		 string

Идентификатор устройства в реестре Yandex IoT.
triggers[].
rule.
iotMessage.
mqttTopic		 string

MQTT-топик, сообщения котрого активируют триггер.
triggers[].
rule.
iotMessage.
invokeFunction		 object
Инструкции для вызова функции с повторными попытками по мере необходимости.

Вызов функции с повторными попытками.
triggers[].
rule.
iotMessage.
invokeFunction.
functionId		 string

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

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

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

Идентификатор сервисного аккаунта с ролью на вызов функции.
triggers[].
rule.
iotMessage.
invokeFunction.
retrySettings		 object

Политика повторных попыток. Если поле не указано или значение пусто, повторные попытки не предпринимаются.

Параметры повторной попытки вызова функции.
triggers[].
rule.
iotMessage.
invokeFunction.
retrySettings.
retryAttempts		 string (int64)

Максимальное количество повторных попыток (дополнительных вызовов), прежде чем действие будет считаться неудачным.

Допустимые значения — от 1 до 5 включительно.
triggers[].
rule.
iotMessage.
invokeFunction.
retrySettings.
interval		 string

Обязательное поле. Время ожидания между повторными попытками, в секундах.
triggers[].
rule.
objectStorage		 object
triggers[].rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage
triggers[].
rule.
objectStorage.
eventType[]		 string

Обязательное поле. Тип (имя) событий, требуется хотя бы одно значение.

Должен содержать хотя бы один элемент.
triggers[].
rule.
objectStorage.
bucketId		 string
triggers[].
rule.
objectStorage.
prefix		 string

Фильтр, опционально.
triggers[].
rule.
objectStorage.
suffix		 string
triggers[].
rule.
objectStorage.
invokeFunction		 object
Инструкции для вызова функции с повторными попытками по мере необходимости.

Вызов функции с повторными попытками.
triggers[].
rule.
objectStorage.
invokeFunction.
functionId		 string

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

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

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

Идентификатор сервисного аккаунта с ролью на вызов функции.
triggers[].
rule.
objectStorage.
invokeFunction.
retrySettings		 object

Политика повторных попыток. Если поле не указано или значение пусто, повторные попытки не предпринимаются.

Параметры повторной попытки вызова функции.
triggers[].
rule.
objectStorage.
invokeFunction.
retrySettings.
retryAttempts		 string (int64)

Максимальное количество повторных попыток (дополнительных вызовов), прежде чем действие будет считаться неудачным.

Допустимые значения — от 1 до 5 включительно.
triggers[].
rule.
objectStorage.
invokeFunction.
retrySettings.
interval		 string

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

Токен для получения следующей страницы списка. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов.

Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.