Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex IoT Core
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Отправка сообщения
    • Подписка устройства или реестра на получение сообщений
    • Просмотр журнала подключений
    • Создание триггера для топика
    • Управление реестрами
      • Получение информации о реестре
      • Создание реестра
      • Изменение реестра
      • Удаление реестра
    • Управление устройствами
      • Управление алиасами топиков
        • Создание алиаса
        • Получение списка алиасов
        • Изменение алиаса
        • Удаление алиаса
      • Получение информации об устройстве
      • Создание устройства
      • Изменение устройства
      • Удаление устройства
    • Управление сертификатами
      • Создание сертификата
      • Управление сертификатами реестра
      • Управление сертификатами устройства
    • Управление паролями
      • Управление паролями реестра
      • Управление паролями устройства
  • Концепции
    • Авторизация
    • Взаимосвязь ресурсов сервиса
    • Параметры подключения MQTT-брокера
    • Отправка сообщений MQTT-брокеру через gRPC
    • Топик
      • Обзор
      • Топики устройства
      • Топики реестра
      • Сабтопик
      • Использование топиков
    • Резервное копирование
    • Квоты и лимиты
  • Практические руководства
    • Все руководства
    • Работа с помощью Mosquitto
      • Отправить сообщение
      • Подписать устройство или реестр на получение сообщений
    • Работа с Yandex IoT Core с устройства с Android на языке Java
    • Работа с Yandex IoT Core на языке C#
    • Работа с Yandex IoT Core на языке Java
    • Запись данных с устройства в Managed Service for PostgreSQL
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • DeviceDataService
      • DeviceService
      • RegistryDataService
      • RegistryService
      • OperationService
    • REST (англ.)
      • Overview
      • DeviceData
        • Overview
        • publish
      • Device
        • Overview
        • addCertificate
        • addPassword
        • create
        • delete
        • deleteCertificate
        • deletePassword
        • get
        • getByName
        • list
        • listCertificates
        • listOperations
        • listPasswords
        • update
      • RegistryData
        • Overview
        • publish
      • Registry
        • Overview
        • addCertificate
        • addPassword
        • create
        • delete
        • deleteCertificate
        • deletePassword
        • get
        • getByName
        • list
        • listCertificates
        • listDeviceTopicAliases
        • listOperations
        • listPasswords
        • update
  • Вопросы и ответы
  1. Справочник API
  2. REST (англ.)
  3. Device
  4. getByName

Method getByName

Статья создана
Yandex Cloud
  • HTTP request
  • Query parameters
  • Response

HTTP request

GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices:getByName

Query parameters

Parameter Description
registryId Required. ID of the registry to get device. To get a registry ID make a list request. The maximum string length in characters is 50.
deviceName Required. Name of the device to return. To get a device name make a list request. The maximum string length in characters is 50. Value must match the regular expression [a-zA-Z0-9_-]*.
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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "registryId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "topicAliases": "object",
  "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 text format.

name string

Name of the device. The name is unique within the registry.

description string

Description of the device. 0-256 characters long.

topicAliases object

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 string

Status of the device.

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

Device monitoring data, returns if FULL view specified.

monitoringData.
lastAuthIp
string
monitoringData.
lastAuthTime
string (date-time)

String in RFC3339 text format.

monitoringData.
lastPubActivityTime
string (date-time)

String in RFC3339 text format.

monitoringData.
lastSubActivityTime
string (date-time)

String in RFC3339 text format.

monitoringData.
lastOnlineTime
string (date-time)

String in RFC3339 text format.

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

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Query parameters
  • Response