[Документация Yandex Cloud](../../../../../index.md) > [Yandex Serverless Integrations](../../../../index.md) > Справочник API EventRouter > [gRPC (англ.)](../index.md) > [Rule](index.md) > List # EventRouter Service, gRPC: RuleService.List Retrieves the list of rules in the specified folder. ## gRPC request **rpc List ([ListRulesRequest](#yandex.cloud.serverless.eventrouter.v1.ListRulesRequest)) returns ([ListRulesResponse](#yandex.cloud.serverless.eventrouter.v1.ListRulesResponse))** ## ListRulesRequest {#yandex.cloud.serverless.eventrouter.v1.ListRulesRequest} ```json { // Includes only one of the fields `bus_id`, `folder_id` "bus_id": "string", "folder_id": "string", // end of the list of possible fields "page_size": "int64", "page_token": "string", "filter": "string" } ``` #| ||Field | Description || || bus_id | **string** ID of the bus to list rules in. Includes only one of the fields `bus_id`, `folder_id`. ID of the folder on bus to list rules in. || || folder_id | **string** ID of the folder to list rules in. Includes only one of the fields `bus_id`, `folder_id`. ID of the folder on bus to list rules in. || || page_size | **int64** The maximum number of results per response. || || page_token | **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 || |# ## ListRulesResponse {#yandex.cloud.serverless.eventrouter.v1.ListRulesResponse} ```json { "rules": [ { "id": "string", "bus_id": "string", "folder_id": "string", "cloud_id": "string", "created_at": "google.protobuf.Timestamp", "name": "string", "description": "string", "labels": "map", "filter": { // Includes only one of the fields `jq_filter` "jq_filter": "string" // end of the list of possible fields }, "targets": [ { // Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow` "yds": { "database": "string", "stream_name": "string", "service_account_id": "string" }, "ymq": { "queue_arn": "string", "service_account_id": "string" }, "function": { "function_id": "string", "function_tag": "string", "service_account_id": "string", "batch_settings": { "max_count": "int64", "max_bytes": "int64", "cutoff": "google.protobuf.Duration" } }, "container": { "container_id": "string", "container_revision_id": "string", "path": "string", "service_account_id": "string", "batch_settings": { "max_count": "int64", "max_bytes": "int64", "cutoff": "google.protobuf.Duration" } }, "gateway_ws_broadcast": { "gateway_id": "string", "path": "string", "service_account_id": "string", "batch_settings": { "max_count": "int64", "max_bytes": "int64", "cutoff": "google.protobuf.Duration" } }, "logging": { // Includes only one of the fields `log_group_id`, `folder_id` "log_group_id": "string", "folder_id": "string", // end of the list of possible fields "service_account_id": "string" }, "workflow": { "workflow_id": "string", "service_account_id": "string", "batch_settings": { "max_count": "int64", "max_bytes": "int64", "cutoff": "google.protobuf.Duration" } }, // end of the list of possible fields "transformer": { // Includes only one of the fields `jq_transformer` "jq_transformer": "string" // end of the list of possible fields }, "retry_settings": { "retry_attempts": "int64", "maximum_age": "google.protobuf.Duration" }, // Includes only one of the fields `dead_letter_queue` "dead_letter_queue": { "queue_arn": "string", "service_account_id": "string" }, // end of the list of possible fields "status": "Status" } ], "deletion_protection": "bool", "status": "Status" } ], "next_page_token": "string" } ``` #| ||Field | Description || || rules[] | **[Rule](#yandex.cloud.serverless.eventrouter.v1.Rule)** List of rules. || || next_page_token | **string** Token for getting the next page of the list of rules. || |# ## Rule {#yandex.cloud.serverless.eventrouter.v1.Rule} #| ||Field | Description || || id | **string** ID of the rule. || || bus_id | **string** ID of the bus that the rule belongs to. || || folder_id | **string** ID of the folder that the rule resides in. || || cloud_id | **string** ID of the cloud that the rule resides in. || || created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** Creation timestamp. || || 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. || || deletion_protection | **bool** 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 || || jq_filter | **string** JQ filter for matching events. The maximum string length in characters is 1024. Includes only one of the fields `jq_filter`. || |# ## 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`, `gateway_ws_broadcast`, `logging`, `workflow`. || || ymq | **[YmqTarget](#yandex.cloud.serverless.eventrouter.v1.YmqTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow`. || || function | **[FunctionTarget](#yandex.cloud.serverless.eventrouter.v1.FunctionTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow`. || || container | **[ContainerTarget](#yandex.cloud.serverless.eventrouter.v1.ContainerTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow`. || || gateway_ws_broadcast | **[GatewayWebsocketBroadcastTarget](#yandex.cloud.serverless.eventrouter.v1.GatewayWebsocketBroadcastTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow`. || || logging | **[LoggingTarget](#yandex.cloud.serverless.eventrouter.v1.LoggingTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow`. || || workflow | **[WorkflowTarget](#yandex.cloud.serverless.eventrouter.v1.WorkflowTarget)** Includes only one of the fields `yds`, `ymq`, `function`, `container`, `gateway_ws_broadcast`, `logging`, `workflow`. || || transformer | **[Transformer](#yandex.cloud.serverless.eventrouter.v1.Transformer)** Transformer of the target. || || retry_settings | **[RetrySettings](#yandex.cloud.serverless.eventrouter.v1.RetrySettings)** Retry settings of the target. || || dead_letter_queue | **[PutQueueMessage](#yandex.cloud.serverless.eventrouter.v1.PutQueueMessage)** Dead letter queue. Includes only one of the fields `dead_letter_queue`. 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. || || stream_name | **string** Required field. Full stream name, like /ru-central1/aoegtvhtp8ob********/cc8004q4lbo6********/test. || || service_account_id | **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 || || queue_arn | **string** Required field. Queue ARN. Example: yrn:yc:ymq:ru-central1:aoe***:test || || service_account_id | **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 || || function_id | **string** Required field. Function ID. The maximum string length in characters is 50. || || function_tag | **string** Function tag, optional. || || service_account_id | **string** Service account which has call permission on the function, optional. The maximum string length in characters is 50. || || batch_settings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## BatchSettings {#yandex.cloud.serverless.eventrouter.v1.BatchSettings} #| ||Field | Description || || max_count | **int64** Maximum batch size: trigger will send a batch if number of events exceeds this value. Acceptable values are 0 to 1000, inclusive. || || max_bytes | **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 | **[google.protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/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 || || container_id | **string** Required field. Container ID. The maximum string length in characters is 50. || || container_revision_id | **string** Container revision ID. || || path | **string** Endpoint HTTP path to invoke. || || service_account_id | **string** Service account which should be used to call a container, optional. The maximum string length in characters is 50. || || batch_settings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## GatewayWebsocketBroadcastTarget {#yandex.cloud.serverless.eventrouter.v1.GatewayWebsocketBroadcastTarget} #| ||Field | Description || || gateway_id | **string** Required field. Gateway ID. The maximum string length in characters is 50. || || path | **string** Required field. Path. || || service_account_id | **string** Required field. Service account which has permission for writing to websockets. The maximum string length in characters is 50. || || batch_settings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## LoggingTarget {#yandex.cloud.serverless.eventrouter.v1.LoggingTarget} #| ||Field | Description || || log_group_id | **string** The maximum string length in characters is 63. Includes only one of the fields `log_group_id`, `folder_id`. Log group ID or folder ID. || || folder_id | **string** The maximum string length in characters is 63. Includes only one of the fields `log_group_id`, `folder_id`. Log group ID or folder ID. || || service_account_id | **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 || || workflow_id | **string** Required field. Workflow ID. The maximum string length in characters is 50. || || service_account_id | **string** Required field. SA which should be used to start workflow. The maximum string length in characters is 50. || || batch_settings | **[BatchSettings](#yandex.cloud.serverless.eventrouter.v1.BatchSettings)** Batch settings. || |# ## Transformer {#yandex.cloud.serverless.eventrouter.v1.Transformer} #| ||Field | Description || || jq_transformer | **string** JQ string inrerpolation expression for changing event format. The maximum string length in characters is 65536. Includes only one of the fields `jq_transformer`. || |# ## RetrySettings {#yandex.cloud.serverless.eventrouter.v1.RetrySettings} #| ||Field | Description || || retry_attempts | **int64** Maximum number of retries (extra calls) before an action fails. Acceptable values are 0 to 10, inclusive. || || maximum_age | **[google.protobuf.Duration](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/duration)** Event goes to dlq when its age exceeds this value. Default is 24h. || |# ## PutQueueMessage {#yandex.cloud.serverless.eventrouter.v1.PutQueueMessage} #| ||Field | Description || || queue_arn | **string** ID of the queue. || || service_account_id | **string** Required field. Service account which has write permission on the queue. The maximum string length in characters is 50. || |#