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
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list brokers in. To get a folder ID make a list request. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page that should be returned. If the number of available results is larger than Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"brokers": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"logOptions": {
"disabled": true,
"minLevel": "string",
// `brokers[].logOptions` includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields`brokers[].logOptions`
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
brokers[] | object List of brokers. |
brokers[]. id |
string ID of the broker. |
brokers[]. folderId |
string ID of the folder that the broker belongs to. |
brokers[]. 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). |
brokers[]. name |
string Name of the broker. The name is unique within the folder. |
brokers[]. description |
string Description of the broker. 0-256 characters long. |
brokers[]. labels |
object Resource labels as |
brokers[]. status |
string Status of the broker.
|
brokers[]. logOptions |
object Options for logging broker events |
brokers[]. logOptions. disabled |
boolean (boolean) Is logging from broker disabled. |
brokers[]. logOptions. minLevel |
string Minimum log entry level. See [LogLevel.Level] for details.
|
brokers[]. logOptions. logGroupId |
string brokers[].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 |
brokers[]. logOptions. folderId |
string brokers[].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 |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |