IoT Core Broker Service, REST: Broker.Get
Returns the specified broker.
To get the list of available brokers, make a List request.
HTTP request
GET https://iot-broker.api.cloud.yandex.net/iot-broker/v1/brokers/{brokerId}
Path parameters
|
Field |
Description |
|
brokerId |
string Required field. ID of the broker to return. To get a broker ID make a BrokerService.List request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"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"
}
}
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 text format. The range of possible values is from 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 |
object (map<string, 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.
|