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

Jobs - Cancel Scheduled Job

Служба:
IoT Hub
Версия API:
2021-04-12

Отменяет запланированное задание в Центре Интернета вещей. См. https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs для получения дополнительной информации.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}/cancel?api-version=2021-04-12

Параметры URI

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

string

Уникальный идентификатор задания.
api-version
 query True

string

Версия API.

Ответы

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

JobResponse

ХОРОШО.

Определения

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

Параметры для выполнения прямого метода на устройстве.
DeviceCapabilities

Состояние возможностей, включенных на устройстве.
DeviceJobStatistics

Статистика задания относительно состояния выполнения.
JobResponse
Twin

Сведения о состоянии устройства или модуля. Это неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центре Интернета вещей.
TwinProperties

Требуемые и сообщаемые свойства двойника. Максимальная глубина объекта составляет 10.
X509Thumbprint

CloudToDeviceMethod

Object

Параметры для выполнения прямого метода на устройстве.

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

integer (int32)

methodName

string

Имя выполняемого метода.
payload

object

Полезные данные прямого метода в формате JSON размером до 128 КБ.
responseTimeoutInSeconds

integer (int32)

DeviceCapabilities

Object

Состояние возможностей, включенных на устройстве.

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

boolean

Свойство, определяющее, является ли устройство пограничным устройством или нет.

DeviceJobStatistics

Object

Статистика задания относительно состояния выполнения.

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

integer (int32)

Количество устройств, предназначенных для задания.
failedCount

integer (int32)

Количество неудачных заданий.
pendingCount

integer (int32)

Количество ожидающих (запланированных) заданий.
runningCount

integer (int32)

Количество выполняемых заданий.
succeededCount

integer (int32)

Число успешных заданий.

JobResponse

Object
Имя Тип Описание
cloudToDeviceMethod

CloudToDeviceMethod

Тип метода и параметры. Это необходимо, если тип задания — cloudToDeviceMethod.
createdTime

string (date-time)

Созданная система. Игнорируется при создании. Дата и время создания задания.
deviceJobStatistics

DeviceJobStatistics

Сведения о состоянии выполнения задания.
endTime

string (date-time)

Созданная система. Игнорируется при создании. Дата окончания и время задания в формате UTC.
failureReason

string

Причина сбоя, если произошел сбой.
jobId

string

Созданная система. Игнорируется при создании. Уникальный идентификатор задания.
maxExecutionTimeInSeconds

integer (int64)

Максимальное время выполнения в секундах.
queryCondition

string

Условие запроса устройства.
startTime

string (date-time)

Дата начала и время запланированного задания в формате UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Созданная система. Игнорируется при создании. Состояние задания.
statusMessage

string

Сообщение о состоянии задания.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Тип задания.
updateTwin

Twin

Сведения о состоянии устройства или модуля. Это неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центре Интернета вещей.

Twin

Object

Сведения о состоянии устройства или модуля. Это неявно создается и удаляется при создании или удалении соответствующего удостоверения устройства или модуля в Центре Интернета вещей.

Имя Тип Описание
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Тип проверки подлинности, используемый устройством.
capabilities

DeviceCapabilities

Состояние возможностей, включенных на устройстве.
cloudToDeviceMessageCount

integer (int32)

Количество отправленных сообщений из облака на устройство.
connectionState enum:
  • Connected
  • Disconnected

Состояние подключения устройства.
deviceEtag

string

Строка, представляющая ETag для устройства, как по RFC7232.
deviceId

string

Уникальный идентификатор устройства в реестре удостоверений Центра Интернета вещей. Это строка с учетом регистра (до 128 символов длиной) 7-разрядной буквенно-цифровых символов ASCII, и следующие специальные символы {'-", ":", ".", "+", "%", "_", "#", "#", "?", "!", "(", ")", ",", "=", "@", "@", "$", "$", ""}.
deviceScope

string

Область действия устройства.
etag

string

Строка, представляющая ETag для двойника устройства, как по RFC7232.
lastActivityTime

string (date-time)

Дата и время последнего подключения или получения или отправки сообщения устройства. Дата и время задается в формате даты и времени ISO8601 в формате UTC, например 2015-01-28T16:24:48.789Z. Это значение не обновляется, если устройство использует протокол HTTP/1 для выполнения операций обмена сообщениями.
moduleId

string

Уникальный идентификатор модуля в реестре удостоверений Центра Интернета вещей. Это строка с учетом регистра (до 128 символов длиной) 7-разрядной буквенно-цифровых символов ASCII, и следующие специальные символы {'-", ":", ".", "+", "%", "_", "#", "#", "?", "!", "(", ")", ",", "=", "@", "@", "$", "$", ""}.
parentScopes

string[]

Области пограничных устройств верхнего уровня, если это применимо. Доступно только для пограничных устройств.
properties

TwinProperties

Требуемые и сообщаемые свойства двойника.
status enum:
  • disabled
  • enabled

Состояние включенного устройства. Если устройство отключено, устройство не может подключиться к службе.
statusReason

string

Причина текущего состояния устройства, если она есть.
statusUpdateTime

string (date-time)

Дата и время последнего обновления состояния устройства.
tags

object

Коллекция пар "ключ-значение" считывает и записывается внутренним приложением решения. Они не видны приложениям устройств. Эти ключи кодируются в кодировке UTF-8, учитывает регистр и up-to 1 КБ длиной. Допустимые символы исключают символы элемента управления ЮНИКОД (сегменты C0 и C1), ".", "$" и пробелы. Значения — это объекты JSON, up-to 4 КБ в длину.
version

integer (int64)

Версия для двойника устройства, включая теги и требуемые свойства
x509Thumbprint

X509Thumbprint

Отпечаток X509 устройства.

TwinProperties

Object

Требуемые и сообщаемые свойства двойника. Максимальная глубина объекта составляет 10.

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

object

Коллекция пар "ключ-значение" требуемого свойства. Ключи кодируются в кодировке UTF-8, учитывает регистр и up-to 1 КБ длиной. Допустимые символы исключают символы элемента управления ЮНИКОД (сегменты C0 и C1), ".", "$" и пробелы. Требуемые значения порперти — это объекты JSON, up-to 4 КБ в длину.
reported

object

Коллекция пар "ключ-значение" свойства. Ключи кодируются в кодировке UTF-8, учитывает регистр и up-to 1 КБ длиной. Допустимые символы исключают символы элемента управления ЮНИКОД (сегменты C0 и C1), ".", "$" и пробелы. Указанные значения свойств — это объекты JSON, up-to 4 КБ в длину.

X509Thumbprint

Object
Имя Тип Описание
primaryThumbprint

string

Основной отпечаток сертификата клиента X509.
secondaryThumbprint

string

Вторичный отпечаток сертификата клиента X509.