Devices - Run Command

Служба:

IoT Central

Версия API:

2022-07-31

Выполнение команды устройства
Выполните команду на устройстве.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
baseDomain	path	True	string	Базовый домен для всех запросов службы Azure IoT Central.
commandName	path	True	string	Имя этой команды устройства.
deviceId	path	True	string	Уникальный идентификатор устройства.
subdomain	path	True	string	Поддомен приложения.
api-version	query	True	string	Версия вызываемого API.

Текст запроса

Имя	Тип	Описание
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Время ожидания подключения в секундах, чтобы ждать, пока отключенное устройство будет подключено к сети. Значение по умолчанию — 0 секунд.
request		Полезные данные для команды устройства поддерживают любые примитивные типы или объекты.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Время ожидания ответа в секундах, чтобы дождаться завершения команды на устройстве. Значение по умолчанию — 30 секунд.

Ответы

Имя	Тип	Описание
201 Created	DeviceCommand	Успех
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	олицетворения учетной записи пользователя

Примеры

Send command

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

HTTP

POST https://appsubdomain.azureiotcentral.com/api/devices/mx1/commands/CoolDown?api-version=2022-07-31

{
  "request": {
    "tempVal": 30
  }
}

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

Код состояния:

201

{}

Определения

Имя	Описание
DeviceCommand	Определение команды устройства.
Error	Определение ошибки ответа.
ErrorDetails	Подробные сведения об ошибке.

DeviceCommand

Object

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

Имя	Тип	Описание
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Время ожидания подключения в секундах, чтобы ждать, пока отключенное устройство будет подключено к сети. Значение по умолчанию — 0 секунд.
id	string	Идентификатор запроса выполнения команды устройства.
request		Полезные данные для команды устройства поддерживают любые примитивные типы или объекты.
response		Полезные данные ответа команды устройства поддерживают любые примитивные типы или объекты.
responseCode	integer (int32)	Код состояния ответа команды устройства.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Время ожидания ответа в секундах, чтобы дождаться завершения команды на устройстве. Значение по умолчанию — 30 секунд.

Error

Object

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

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке для текущего запроса.

ErrorDetails

Object

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

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сведения об сообщении об ошибке.
requestId	string	Идентификатор корреляции для текущего запроса.
time	string (date-time-rfc1123)	Время сбоя запроса на ошибку.