EventRouter Service, REST: Rule.List

Written by

Updated at December 17, 2024

HTTP request
Query parameters
Response
Rule
Filter
Target
YdsTarget
YmqTarget
FunctionTarget
BatchSettings
ContainerTarget
GatewayWebsocketBroadcastTarget
LoggingTarget
WorkflowTarget
Transformer
RetrySettings
PutQueueMessage

Retrieves the list of rules in the specified folder.

HTTP request

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

Query parameters

Field	Description
busId	string ID of the bus to list rules in. Includes only one of the fields `busId`, `folderId`. ID of the folder on bus to list rules in.
folderId	string ID of the folder to list rules in. Includes only one of the fields `busId`, `folderId`. ID of the folder on bus to list rules in.
pageSize	string (int64) The maximum number of results per response.
pageToken	string Page token. To get the next page of results, set `page_token` to the `next_page_token` returned by a previous list request.
filter	string Supported fields for filter: name created_at

Response

HTTP Code: 200 - OK

{
  "rules": [
    {
      "id": "string",
      "busId": "string",
      "folderId": "string",
      "cloudId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "filter": {
        // Includes only one of the fields `jqFilter`
        "jqFilter": "string"
        // end of the list of possible fields
      },
      "targets": [
        {
          // Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`
          "yds": {
            "database": "string",
            "streamName": "string",
            "serviceAccountId": "string"
          },
          "ymq": {
            "queueArn": "string",
            "serviceAccountId": "string"
          },
          "function": {
            "functionId": "string",
            "functionTag": "string",
            "serviceAccountId": "string",
            "batchSettings": {
              "maxCount": "string",
              "maxBytes": "string",
              "cutoff": "string"
            }
          },
          "container": {
            "containerId": "string",
            "containerRevisionId": "string",
            "path": "string",
            "serviceAccountId": "string",
            "batchSettings": {
              "maxCount": "string",
              "maxBytes": "string",
              "cutoff": "string"
            }
          },
          "gatewayWsBroadcast": {
            "gatewayId": "string",
            "path": "string",
            "serviceAccountId": "string",
            "batchSettings": {
              "maxCount": "string",
              "maxBytes": "string",
              "cutoff": "string"
            }
          },
          "logging": {
            // Includes only one of the fields `logGroupId`, `folderId`
            "logGroupId": "string",
            "folderId": "string",
            // end of the list of possible fields
            "serviceAccountId": "string"
          },
          "workflow": {
            "workflowId": "string",
            "serviceAccountId": "string",
            "batchSettings": {
              "maxCount": "string",
              "maxBytes": "string",
              "cutoff": "string"
            }
          },
          // end of the list of possible fields
          "transformer": {
            // Includes only one of the fields `jqTransformer`
            "jqTransformer": "string"
            // end of the list of possible fields
          },
          "retrySettings": {
            "retryAttempts": "string",
            "maximumAge": "string"
          },
          // Includes only one of the fields `deadLetterQueue`
          "deadLetterQueue": {
            "queueArn": "string",
            "serviceAccountId": "string"
          },
          // end of the list of possible fields
          "status": "string"
        }
      ],
      "deletionProtection": "boolean",
      "status": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

rules[]

Rule

List of rules.

nextPageToken

string

Token for getting the next page of the list of rules.

Rule

Field	Description
id	string ID of the rule.
busId	string ID of the bus that the rule belongs to.
folderId	string ID of the folder that the rule resides in.
cloudId	string ID of the cloud that the rule resides in.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string Name of the rule.
description	string Description of the rule.
labels	object (map<string, string>) Resource labels as `key:value` pairs.
filter	Filter Filter for the rule.
targets[]	Target Targets of the rule.
deletionProtection	boolean Flag that disallow deletion of the rule.
status	enum (Status) Rule status `STATUS_UNSPECIFIED` `CREATING`: Rule creation in progress, rule is not enabled yet `ENABLED`: Rule is operating `UPDATING`: Rule update in progress, rule is disabled during update `DISABLED`: Rule is explicitly disabled by the user `DELETING`: Rule deletion in progress

Filter

Field

Description

jqFilter

string

JQ filter for matching events.

Includes only one of the fields jqFilter.

Target

Field	Description
yds	YdsTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
ymq	YmqTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
function	FunctionTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
container	ContainerTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
gatewayWsBroadcast	GatewayWebsocketBroadcastTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
logging	LoggingTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
workflow	WorkflowTarget Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`.
transformer	Transformer Transformer of the target.
retrySettings	RetrySettings Retry settings of the target.
deadLetterQueue	PutQueueMessage Dead letter queue. Includes only one of the fields `deadLetterQueue`. Dead letter settings of the target.
status	enum (Status) Status of the target. `STATUS_UNSPECIFIED` `ENABLED`: Target is enabled. `DISABLED`: Target is disabled. `RESOURCE_NOT_FOUND`: Target does not exist. `PERMISSION_DENIED`: Service account does not have read permission on source. `SUBJECT_NOT_FOUND`: Service account not found.

YdsTarget

Field	Description
database	string Required field. Stream database.
streamName	string Required field. Full stream name, like /ru-central1/aoegtvhtp8ob******/cc8004q4lbo6******/test.
serviceAccountId	string Required field. Service account, which has write permission on the stream.

YmqTarget

Field

Description

queueArn

string

Required field. Queue ARN.
Example: yrn:yc:ymq:ru-central1:aoe***:test

serviceAccountId

string

Required field. Service account which has write access to the queue.

FunctionTarget

Field	Description
functionId	string Required field. Function ID.
functionTag	string Function tag, optional.
serviceAccountId	string Service account which has call permission on the function, optional.
batchSettings	BatchSettings Batch settings.

BatchSettings

Field	Description
maxCount	string (int64) Maximum batch size: trigger will send a batch if number of events exceeds this value.
maxBytes	string (int64) Maximum batch size: trigger will send a batch if total size of events exceeds this value.
cutoff	string (duration) Required field. Maximum batch size: trigger will send a batch if its lifetime exceeds this value.

ContainerTarget

Field	Description
containerId	string Required field. Container ID.
containerRevisionId	string Container revision ID.
path	string Endpoint HTTP path to invoke.
serviceAccountId	string Service account which should be used to call a container, optional.
batchSettings	BatchSettings Batch settings.

GatewayWebsocketBroadcastTarget

Field	Description
gatewayId	string Required field. Gateway ID.
path	string Required field. Path.
serviceAccountId	string Required field. Service account which has permission for writing to websockets.
batchSettings	BatchSettings Batch settings.

LoggingTarget

Field	Description
logGroupId	string Includes only one of the fields `logGroupId`, `folderId`. Log group ID or folder ID.
folderId	string Includes only one of the fields `logGroupId`, `folderId`. Log group ID or folder ID.
serviceAccountId	string Required field. Service account which has permission for writing logs.

WorkflowTarget

Field	Description
workflowId	string Required field. Workflow ID.
serviceAccountId	string Required field. SA which should be used to start workflow.
batchSettings	BatchSettings Batch settings.

Transformer

Field

Description

jqTransformer

string

JQ string inrerpolation expression for changing event format.

Includes only one of the fields jqTransformer.

RetrySettings

Field

Description

retryAttempts

string (int64)

Maximum number of retries (extra calls) before an action fails.

maximumAge

string (duration)

Event goes to dlq when its age exceeds this value. Default is 24h.

PutQueueMessage

Field

Description

queueArn

string

ID of the queue.

serviceAccountId

string

Required field. Service account which has write permission on the queue.

EventRouter Service, REST: Rule.List

HTTP requestHTTP request

Query parametersQuery parameters

ResponseResponse

RuleRule

FilterFilter

TargetTarget

YdsTargetYdsTarget

YmqTargetYmqTarget

FunctionTargetFunctionTarget

BatchSettingsBatchSettings

ContainerTargetContainerTarget

GatewayWebsocketBroadcastTargetGatewayWebsocketBroadcastTarget

LoggingTargetLoggingTarget

WorkflowTargetWorkflowTarget

TransformerTransformer

RetrySettingsRetrySettings

PutQueueMessagePutQueueMessage

Was the article helpful?

HTTP request

Query parameters

Response

Rule

Filter

Target

YdsTarget

YmqTarget

FunctionTarget

BatchSettings

ContainerTarget

GatewayWebsocketBroadcastTarget

LoggingTarget

WorkflowTarget

Transformer

RetrySettings

PutQueueMessage