Связаться с намиПодключиться

EventRouter Service, REST: Bus.List

Статья создана
Обновлена 24 апреля 2025 г.

Retrieves the list of buses in the specified folder.

HTTP request

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

Query parameters

Field

Description

folderId

string

Required field. ID of the folder to list buses in.

pageSize

string (int64)

Maximum number of buses to return.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListBusesResponse.nextPageToken returned by a previous list request.

filter

string

Supported fields for filter:
name
created_at

Response

HTTP Code: 200 - OK

{
  "buses": [
    {
      "id": "string",
      "folderId": "string",
      "cloudId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "deletionProtection": "boolean",
      "status": "string",
      "loggingEnabled": "boolean",
      "logOptions": {
        // Includes only one of the fields `logGroupId`, `folderId`
        "logGroupId": "string",
        "folderId": "string",
        // end of the list of possible fields
        "minLevel": "string",
        "serviceAccountId": "string"
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

buses[]

Bus

List of buses.

nextPageToken

string

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

Bus

Field

Description

id

string

ID of the bus.

folderId

string

ID of the folder that the bus belongs to.

cloudId

string

ID of the cloud that the bus 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 bus.

description

string

Description of the bus.

labels

object (map<string, string>)

Resource labels as key:value pairs.

deletionProtection

boolean

Deletion protection.

status

enum (Status)

Status of the bus.

  • STATUS_UNSPECIFIED
  • CREATING
  • ACTIVE
  • DELETING

loggingEnabled

boolean

Is logging from the bus enabled.

logOptions

LogOptions

Options for logging from the bus.

LogOptions

Field

Description

logGroupId

string

Entry will be written to log group resolved by ID.

Includes only one of the fields logGroupId, folderId.

Log entries destination.

folderId

string

Entry will be written to default log group for specified folder.

Includes only one of the fields logGroupId, folderId.

Log entries destination.

minLevel

enum (Level)

Minimum log entry level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

serviceAccountId

string

Required field. Service account, which has permission to write to destination
Предыдущая
Get
Следующая
Create