IoT Core Service, REST: Device.Get
Returns the specified device.
To get the list of available devices, make a List request.
HTTP request
GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices/{deviceId}
Path parameters
Field |
Description |
deviceId |
string Required field. ID of the device to return. To get a device ID make a DeviceService.List request. |
Query parameters
Field |
Description |
deviceView |
enum (DeviceView) Specifies which parts of the device resource should be returned
|
Response
HTTP Code: 200 - OK
{
"id": "string",
"registryId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"topicAliases": "string",
"status": "string",
"monitoringData": {
"lastAuthIp": "string",
"lastAuthTime": "string",
"lastPubActivityTime": "string",
"lastSubActivityTime": "string",
"lastOnlineTime": "string"
}
}
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 |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
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 |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
lastPubActivityTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
lastSubActivityTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
lastOnlineTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |