Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex IoT Core
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • GetByName
        • List
        • Create
        • Update
        • Delete
        • ListCertificates
        • AddCertificate
        • DeleteCertificate
        • ListPasswords
        • AddPassword
        • DeletePassword
        • ListOperations
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • GetDeviceRequest
  • Device
  • DeviceMonitoringData
  1. Devices API reference
  2. gRPC
  3. Device
  4. Get

IoT Core Service, gRPC: DeviceService.Get

Written by
Yandex Cloud
Updated at April 24, 2025
  • gRPC request
  • GetDeviceRequest
  • Device
  • DeviceMonitoringData

Returns the specified device.

To get the list of available devices, make a List request.

gRPC request

rpc Get (GetDeviceRequest) returns (Device)

GetDeviceRequest

{
  "device_id": "string",
  "device_view": "DeviceView"
}

Field

Description

device_id

string

Required field. ID of the device to return.

To get a device ID make a DeviceService.List request.

device_view

enum DeviceView

Specifies which parts of the device resource should be returned
in the response.

  • BASIC: Server responses without monitoring data.
    The default value.
  • FULL: Server responses with monitoring data.

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

google.protobuf.Timestamp

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. my/custom/alias match to $device/abcdef/events.

status

enum Status

Status of the device.

  • STATUS_UNSPECIFIED
  • CREATING: Device is being created.
  • ACTIVE: Device is ready to use.
  • DELETING: Device is being deleted.

monitoring_data

DeviceMonitoringData

Device monitoring data, returns if FULL view specified.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

DeviceMonitoringData

Field

Description

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

Was the article helpful?

Previous
Overview
Next
GetByName
Yandex project
© 2025 Yandex.Cloud LLC