Подключиться
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`, `containerRegistry`, `cloudLogs`
        "timer": {
          "cronExpression": "string",

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

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

Триггер для вызова бессерверной функции. Дополнительные сведения см. в разделе Triggers.
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, containerRegistry, cloudLogs

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

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

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

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

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

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

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

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

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

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

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

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

Идентификатор сервисного аккаунта с правами на вызов функции.
triggers[].
rule.
timer.
invokeFunctionWithRetry.
retrySettings		 object

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

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

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

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

Обязательное поле. Время ожидания между повторными попытками, в секундах.
triggers[].
rule.
timer.
invokeFunctionWithRetry.
deadLetterQueue		 object

Политика DLQ (отсутствие значения означает отказ от сообщения).
triggers[].
rule.
timer.
invokeFunctionWithRetry.
deadLetterQueue.
queueId		 string

Идентификатор очереди.
triggers[].
rule.
timer.
invokeFunctionWithRetry.
deadLetterQueue.
serviceAccountId		 string

Обязательное поле. Сервисный аккаунт с правами на запись в очередь.

Максимальная длина строки в символах — 50.
triggers[].
rule.
messageQueue		 object
Правило для триггера очереди сообщений.
triggers[].rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage, containerRegistry, cloudLogs

Правило для активации триггера очереди сообщений.
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)

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

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

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

Правило для активации триггера 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.
iotMessage.
invokeFunction.
deadLetterQueue		 object

Политика DLQ (отсутствие значения означает отказ от сообщения).
triggers[].
rule.
iotMessage.
invokeFunction.
deadLetterQueue.
queueId		 string

Идентификатор очереди.
triggers[].
rule.
iotMessage.
invokeFunction.
deadLetterQueue.
serviceAccountId		 string

Обязательное поле. Сервисный аккаунт с правами на запись в очередь.

Максимальная длина строки в символах — 50.
triggers[].
rule.
objectStorage		 object
triggers[].rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage, containerRegistry, cloudLogs
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

Обязательное поле. Время ожидания между повторными попытками, в секундах.
triggers[].
rule.
objectStorage.
invokeFunction.
deadLetterQueue		 object

Политика DLQ (отсутствие значения означает отказ от сообщения).
triggers[].
rule.
objectStorage.
invokeFunction.
deadLetterQueue.
queueId		 string

Идентификатор очереди.
triggers[].
rule.
objectStorage.
invokeFunction.
deadLetterQueue.
serviceAccountId		 string

Обязательное поле. Сервисный аккаунт с правами на запись в очередь.

Максимальная длина строки в символах — 50.
triggers[].
rule.
containerRegistry		 object
triggers[].rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage, containerRegistry, cloudLogs
triggers[].
rule.
containerRegistry.
eventType[]		 string

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

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

Идентификатор реестра.
triggers[].
rule.
containerRegistry.
imageName		 string

Имя Docker-образа. Фильтр, опционально.
triggers[].
rule.
containerRegistry.
tag		 string

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

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

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

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

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

Идентификатор сервисного аккаунта с правами на вызов функции.
triggers[].
rule.
containerRegistry.
invokeFunction.
retrySettings		 object

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

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

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

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

Обязательное поле. Время ожидания между повторными попытками, в секундах.
triggers[].
rule.
containerRegistry.
invokeFunction.
deadLetterQueue		 object

Политика DLQ (отсутствие значения означает отказ от сообщения).
triggers[].
rule.
containerRegistry.
invokeFunction.
deadLetterQueue.
queueId		 string

Идентификатор очереди.
triggers[].
rule.
containerRegistry.
invokeFunction.
deadLetterQueue.
serviceAccountId		 string

Обязательное поле. Сервисный аккаунт с правами на запись в очередь.

Максимальная длина строки в символах — 50.
triggers[].
rule.
cloudLogs		 object
triggers[].rule включает только одно из полей timer, messageQueue, iotMessage, objectStorage, containerRegistry, cloudLogs
triggers[].
rule.
cloudLogs.
logGroupId[]		 string

Идентификаторы групп журналов, по крайней мере, одно значение обязательно.
triggers[].
rule.
cloudLogs.
batchSettings		 object
Обязательное поле. Пакетные настройки для обработки событий журнала.
triggers[].
rule.
cloudLogs.
batchSettings.
size		 string (int64)

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

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

Максимальное время ожидания. Триггер отправит группу сообщений в функцию, когда число сообщений в лог-группе достигнет size или истечет cutoff.

Допустимые значения — от 1 seconds до 60 seconds включительно.
triggers[].
rule.
cloudLogs.
invokeFunction		 object
Инструкции для вызова функции с повторными попытками по мере необходимости.

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

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

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

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

Идентификатор сервисного аккаунта с правами на вызов функции.
triggers[].
rule.
cloudLogs.
invokeFunction.
retrySettings		 object

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

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

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

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

Обязательное поле. Время ожидания между повторными попытками, в секундах.
triggers[].
rule.
cloudLogs.
invokeFunction.
deadLetterQueue		 object

Политика DLQ (отсутствие значения означает отказ от сообщения).
triggers[].
rule.
cloudLogs.
invokeFunction.
deadLetterQueue.
queueId		 string

Идентификатор очереди.
triggers[].
rule.
cloudLogs.
invokeFunction.
deadLetterQueue.
serviceAccountId		 string

Обязательное поле. Сервисный аккаунт с правами на запись в очередь.

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

Состояние триггера
nextPageToken string

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

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