IoT Core Service, gRPC: DeviceService.GetByName
gRPC request
rpc GetByName (GetByNameDeviceRequest) returns (Device)
GetByNameDeviceRequest
{
"registry_id": "string",
"device_name": "string",
"device_view": "DeviceView"
}
|
Field |
Description |
|
registry_id |
string Required field. ID of the registry to get device. To get a registry ID make a yandex.cloud.iot.devices.v1.RegistryService.List request. |
|
device_name |
string Required field. Name of the device to return. To get a device name make a DeviceService.List request. |
|
device_view |
enum DeviceView Specifies which parts of the device resource should be returned
|
Device
{
"id": "string",
"registry_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"topic_aliases": "map<string, string>",
"status": "Status",
"monitoring_data": {
"last_auth_ip": "string",
"last_auth_time": "google.protobuf.Timestamp",
"last_pub_activity_time": "google.protobuf.Timestamp",
"last_sub_activity_time": "google.protobuf.Timestamp",
"last_online_time": "google.protobuf.Timestamp",
"last_disconnect_time": "google.protobuf.Timestamp"
},
"labels": "map<string, string>"
}
A device. For more information, see Device.
|
Field |
Description |
|
id |
string ID of the device. |
|
registry_id |
string ID of the registry that the device belongs to. |
|
created_at |
Creation timestamp. |
|
name |
string Name of the device. The name is unique within the registry. |
|
description |
string Description of the device. 0-256 characters long. |
|
topic_aliases |
object (map<string, string>) Alias of a device topic. Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. |
|
status |
enum Status Status of the device.
|
|
monitoring_data |
Device monitoring data, returns if FULL view specified. |
|
labels |
object (map<string, string>) Resource labels as |
DeviceMonitoringData
|
Field |
Description |
|
last_auth_ip |
string |
|
last_auth_time |
|
|
last_pub_activity_time |
|
|
last_sub_activity_time |
|
|
last_online_time |
|
|
last_disconnect_time |