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
Parameter | Description |
---|---|
brokerId | Required. ID of the broker to return. To get a broker ID make a list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"logOptions": {
"disabled": true,
"minLevel": "string",
// `logOptions` includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields`logOptions`
}
}
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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 Resource labels as |
status | string Status of the broker.
|
logOptions | object Options for logging broker events |
logOptions. disabled |
boolean (boolean) Is logging from broker disabled. |
logOptions. minLevel |
string Minimum log entry level. See [LogLevel.Level] for details.
|
logOptions. logGroupId |
string logOptions includes only one of the fields logGroupId , folderId Entry should be written to log group resolved by ID. Value must match the regular expression |
logOptions. folderId |
string logOptions includes only one of the fields logGroupId , folderId Entry should be written to default log group for specified folder. Value must match the regular expression |