IoT Core Service, gRPC: DeviceService.GetByName
gRPC request
rpc GetByName (GetByNameDeviceRequest) returns (Device)
GetByNameDeviceRequest
{
"registryId": "string",
"deviceName": "string",
"deviceView": "DeviceView"
}
|
Field |
Description |
|
registryId |
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. |
|
deviceName |
string Required field. Name of the device to return. To get a device name make a DeviceService.List request. |
|
deviceView |
enum DeviceView Specifies which parts of the device resource should be returned
|
Device
{
"id": "string",
"registryId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"topicAliases": "string",
"status": "Status",
"monitoringData": {
"lastAuthIp": "string",
"lastAuthTime": "google.protobuf.Timestamp",
"lastPubActivityTime": "google.protobuf.Timestamp",
"lastSubActivityTime": "google.protobuf.Timestamp",
"lastOnlineTime": "google.protobuf.Timestamp"
}
}
A device. For more information, see Device.
|
Field |
Description |
|
id |
string ID of the device. |
|
registryId |
string ID of the registry that the device belongs to. |
|
createdAt |
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. |
|
topicAliases |
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.
|
|
monitoringData |
Device monitoring data, returns if FULL view specified. |
DeviceMonitoringData
|
Field |
Description |
|
lastAuthIp |
string |
|
lastAuthTime |
|
|
lastPubActivityTime |
|
|
lastSubActivityTime |
|
|
lastOnlineTime |