Skip to main content

List

Retrieves the list of brokers in the specified folder.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListBrokersRequest =
  cloudApi.iot.broker_broker_service.ListBrokersRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.BrokerServiceClient);

  const result = await client.list(
    ListBrokersRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

ListBrokersRequest​

folderId : string​

ID of the folder to list brokers in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : int64​

The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListBrokersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken : string​

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

ListBrokersResponse​

brokers : Broker​

List of brokers.

nextPageToken : string​

Token for getting the next page of the list. If the number of results is greater than the specified ListBrokersRequest.page_size, use next_page_token as the value for the ListBrokersRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

Broker​

A broker.

Status​
  • STATUS_UNSPECIFIED

  • CREATING

    Broker is being created.

  • ACTIVE

    Broker is ready to use.

  • DELETING

    Broker is being deleted.

id : string​

ID of the broker.

folderId : string​

ID of the folder that the broker belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the broker. The name is unique within the folder.

description : string​

Description of the broker. 0-256 characters long.

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.

status : Status​

Status of the broker.

logOptions : LogOptions​

Options for logging broker events

LogOptions​

disabled : bool​

Is logging from broker disabled.

One of destination​

Log entries destination.

  • logGroupId : string​

    Entry should be written to log group resolved by ID.

  • folderId : string​

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

minLevel : yandex.cloud.logging.v1.LogLevel.Level​

Minimum log entry level.

See LogLevel.Level for details.