Поделиться через

Devices - Get

  • Ссылка
Служба:
IoT Central
Версия API:
2022-07-31

получить устройство по идентификатору;
Получение сведений о существующем устройстве по идентификатору устройства.

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

Параметры URI

Имя В Обязательно Тип Описание
baseDomain
 path True

string

Базовый домен для всех запросов службы Azure IoT Central.
deviceId
 path True

string

Уникальный идентификатор устройства.
subdomain
 path True

string

Поддомен приложения.
api-version
 query True

string

Версия вызываемого API.

Ответы

Имя Тип Описание
200 OK

Device

Успех
Other Status Codes

Error

Ответ об ошибке, полученный от службы IoT Central.

Заголовки

x-ms-error-code: string

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Get device by ID

Образец запроса

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

Пример ответа

Код состояния:
200 
{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

Определения

Имя Описание
Device

Определение устройства.
Error

Определение ошибки ответа.
ErrorDetails

Подробные сведения об ошибке.

Device

Object

Определение устройства.

Имя Тип Описание
displayName

string

Отображаемое имя устройства.
enabled

boolean

Включена ли подключение устройства к IoT Central.
etag

string

ETag используется для предотвращения конфликтов в обновлениях устройств.
id

string

Уникальный идентификатор устройства.
organizations

string[]

Список идентификаторов организации, которые устройство является частью, поддерживается только одна организация сегодня, несколько организаций будут поддерживаться в ближайшее время.
provisioned

boolean

Выделены ли ресурсы для устройства.
simulated

boolean

Имитируется ли устройство.
template

string

Определение шаблона устройства для устройства.

Error

Object

Определение ошибки ответа.

Имя Тип Описание
error

ErrorDetails

Сведения об ошибке для текущего запроса.

ErrorDetails

Object

Подробные сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.
message

string

Сведения об сообщении об ошибке.
requestId

string

Идентификатор корреляции для текущего запроса.
time

string (date-time-rfc1123)

Время сбоя запроса на ошибку.