IoT Core Broker Service, REST: Broker.List
Retrieves the list of brokers in the specified folder.
HTTP request
GET https://iot-broker.api.cloud.yandex.net/iot-broker/v1/brokers
Query parameters
Field |
Description |
folderId |
string Required field. ID of the folder to list brokers in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
pageSize |
string (int64) The maximum number of results per page that should be returned. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"brokers": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"status": "string",
"logOptions": {
"disabled": "boolean",
// Includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields
"minLevel": "string"
}
}
],
"nextPageToken": "string"
}
Field |
Description |
brokers[] |
List of brokers. |
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
Broker
A broker.
Field |
Description |
id |
string ID of the broker. |
folderId |
string ID of the folder that the broker belongs to. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
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 |
status |
enum (Status) Status of the broker.
|
logOptions |
Options for logging broker events |
LogOptions
Field |
Description |
disabled |
boolean Is logging from broker disabled. |
logGroupId |
string Entry should be written to log group resolved by ID. Includes only one of the fields Log entries destination. |
folderId |
string Entry should be written to default log group for specified folder. Includes only one of the fields Log entries destination. |
minLevel |
enum (Level) Minimum log entry level. See LogLevel.Level for details.
|