[Yandex Cloud documentation](../../../../index.md) > [Yandex Serverless Integrations](../../../index.md) > EventRouter API reference > [REST](../index.md) > [Rule](index.md) > Get # EventRouter Service, REST: Rule.Get Returns the specified rules. To get the list of all available buses, make a [List](list.md#List) request. ## HTTP request ``` GET https://serverless-eventrouter.api.cloud.yandex.net/eventrouter/v1/rules/{ruleId} ``` ## Path parameters #| ||Field | Description || || ruleId | **string** Required field. ID of the rule to return. || |# ## Response {#yandex.cloud.serverless.eventrouter.v1.Rule} **HTTP Code: 200 - OK** ```json { "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" } ``` #| ||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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://developers.google.com/protocol-buffers/docs/reference/overview). 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](#yandex.cloud.serverless.eventrouter.v1.Filter)** Filter for the rule. || || targets[] | **[Target](#yandex.cloud.serverless.eventrouter.v1.Target)** Targets of the rule. The number of elements must be in the range 1-5. || || deletionProtection | **boolean** Flag that disallow deletion of the rule. || || status | **enum** (Status) Rule status - `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 {#yandex.cloud.serverless.eventrouter.v1.Filter} #| ||Field | Description || || jqFilter | **string** JQ filter for matching events. The maximum string length in characters is 1024. Includes only one of the fields `jqFilter`. || |# ## Target {#yandex.cloud.serverless.eventrouter.v1.Target} #| ||Field | Description || || yds | **[YdsTarget](#yandex.cloud.serverless.eventrouter.v1.YdsTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`. || || ymq | **[YmqTarget](#yandex.cloud.serverless.eventrouter.v1.YmqTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`. || || function | **[FunctionTarget](#yandex.cloud.serverless.eventrouter.v1.FunctionTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`. || || container | **[ContainerTarget](#yandex.cloud.serverless.eventrouter.v1.ContainerTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`. || || gatewayWsBroadcast | **[GatewayWebsocketBroadcastTarget](#yandex.cloud.serverless.eventrouter.v1.GatewayWebsocketBroadcastTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`. || || logging | **[LoggingTarget](#yandex.cloud.serverless.eventrouter.v1.LoggingTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`. || || workflow | **[WorkflowTarget](#yandex.cloud.serverless.eventrouter.v1.WorkflowTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gatewayWsBroadcast`, `logging`, `workflow`. || || transformer | **[Transformer](#yandex.cloud.serverless.eventrouter.v1.Transformer)** Transformer of the target. || || retrySettings | **[RetrySettings](#yandex.cloud.serverless.eventrouter.v1.RetrySettings)** Retry settings of the target. || || deadLetterQueue | **[PutQueueMessage](#yandex.cloud.serverless.eventrouter.v1.PutQueueMessage)** Dead letter queue. Includes only one of the fields `deadLetterQueue`. Dead letter settings of the target. || || status | **enum** (Status) Status of the target. - `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 {#yandex.cloud.serverless.eventrouter.v1.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. The maximum string length in characters is 50. || |# ## YmqTarget {#yandex.cloud.serverless.eventrouter.v1.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. The maximum string length in characters is 50. || |# ## FunctionTarget {#yandex.cloud.serverless.eventrouter.v1.FunctionTarget} #| ||Field | Description || || functionId | **string** Required field. Function ID. The maximum string length in characters is 50. || || functionTag | **string** Function tag, optional. || || serviceAccountId | **string** Service account which has call permission on the function, optional. The maximum string length in characters is 50. || || batchSettings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## BatchSettings {#yandex.cloud.serverless.eventrouter.v1.BatchSettings} #| ||Field | Description || || maxCount | **string** (int64) Maximum batch size: trigger will send a batch if number of events exceeds this value. Acceptable values are 0 to 1000, inclusive. || || maxBytes | **string** (int64) Maximum batch size: trigger will send a batch if total size of events exceeds this value. Acceptable values are 0 to 262144, inclusive. || || cutoff | **string** (duration) Required field. Maximum batch size: trigger will send a batch if its lifetime exceeds this value. || |# ## ContainerTarget {#yandex.cloud.serverless.eventrouter.v1.ContainerTarget} #| ||Field | Description || || containerId | **string** Required field. Container ID. The maximum string length in characters is 50. || || 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. The maximum string length in characters is 50. || || batchSettings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## GatewayWebsocketBroadcastTarget {#yandex.cloud.serverless.eventrouter.v1.GatewayWebsocketBroadcastTarget} #| ||Field | Description || || gatewayId | **string** Required field. Gateway ID. The maximum string length in characters is 50. || || path | **string** Required field. Path. || || serviceAccountId | **string** Required field. Service account which has permission for writing to websockets. The maximum string length in characters is 50. || || batchSettings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## LoggingTarget {#yandex.cloud.serverless.eventrouter.v1.LoggingTarget} #| ||Field | Description || || logGroupId | **string** The maximum string length in characters is 63. Includes only one of the fields `logGroupId`, `folderId`. Log group ID or folder ID. || || folderId | **string** The maximum string length in characters is 63. 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. The maximum string length in characters is 50. || |# ## WorkflowTarget {#yandex.cloud.serverless.eventrouter.v1.WorkflowTarget} #| ||Field | Description || || workflowId | **string** Required field. Workflow ID. The maximum string length in characters is 50. || || serviceAccountId | **string** Required field. SA which should be used to start workflow. The maximum string length in characters is 50. || || batchSettings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## Transformer {#yandex.cloud.serverless.eventrouter.v1.Transformer} #| ||Field | Description || || jqTransformer | **string** JQ string inrerpolation expression for changing event format. The maximum string length in characters is 65536. Includes only one of the fields `jqTransformer`. || |# ## RetrySettings {#yandex.cloud.serverless.eventrouter.v1.RetrySettings} #| ||Field | Description || || retryAttempts | **string** (int64) Maximum number of retries (extra calls) before an action fails. Acceptable values are 0 to 10, inclusive. || || maximumAge | **string** (duration) Event goes to dlq when its age exceeds this value. Default is 24h. || |# ## PutQueueMessage {#yandex.cloud.serverless.eventrouter.v1.PutQueueMessage} #| ||Field | Description || || queueArn | **string** ID of the queue. || || serviceAccountId | **string** Required field. Service account which has write permission on the queue. The maximum string length in characters is 50. || |#