Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex IoT Core
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • GetByName
        • List
        • Create
        • Update
        • Delete
        • ListCertificates
        • AddCertificate
        • DeleteCertificate
        • ListPasswords
        • AddPassword
        • DeletePassword
        • ListOperations
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • История изменений
  • Вопросы и ответы

В этой статье:

  • gRPC request
  • GetDeviceRequest
  • Device
  • DeviceMonitoringData
  1. Справочник API Devices
  2. gRPC (англ.)
  3. Device
  4. Get

IoT Core Service, gRPC: DeviceService.Get

Статья создана
Yandex Cloud
Обновлена 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

Была ли статья полезна?

Предыдущая
Overview
Следующая
GetByName
Проект Яндекса
© 2025 ООО «Яндекс.Облако»