IoT Core Service, REST: Registry.getByName
HTTP request
GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/registries:getByName
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list registries in. To get a folder ID make a list request. The maximum string length in characters is 50. |
registryName | Required. Name of the registry to return. To get a registry Name make a list request. The maximum string length in characters is 50. Value must match the regular expression |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"logGroupId": "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 registry. For more information, see Registry.
Field | Description |
---|---|
id | string ID of the registry. |
folderId | string ID of the folder that the registry 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 registry. The name is unique within the folder. |
description | string Description of the registry. 0-256 characters long. |
labels | object Resource labels as |
status | string Status of the registry.
|
logGroupId | string ID of the logs group for the specified registry. |
logOptions | object Options for logging registry events |
logOptions. disabled |
boolean (boolean) Is logging from registry 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 |