Jobs - Get

Служба:

IoT Central

Версия API:

2022-07-31

Получение задания по идентификатору
Получение сведений о запущенном или завершенном задании по идентификатору задания.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
baseDomain	path	True	string	Базовый домен для всех запросов службы Azure IoT Central.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	Уникальный идентификатор задания.
subdomain	path	True	string	Поддомен приложения.
api-version	query	True	string	Версия вызываемого API.

Ответы

Имя	Тип	Описание
200 OK	Job	Успех
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 a job by ID

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

HTTP

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

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

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

200

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Определения

Имя	Описание
CloudPropertyJobData	Данные задания облачного свойства.
CommandJobData	Определение данных задания команды.
DeviceTemplateMigrationJobData	Определение данных задания миграции шаблона устройства.
Error	Определение ошибки ответа.
ErrorDetails	Подробные сведения об ошибке.
Job	Определение задания.
JobBatch	Определение пакетной службы задания.
JobBatchType	Выполняется ли пакетная обработка на указанном количестве устройств или в процентах от общего числа устройств.
JobCancellationThreshold	Определение порогового значения отмены задания.
JobCancellationThresholdType	Указывает, соответствует ли пороговое значение отмены заданному количеству устройств или проценту от общего числа устройств.
JobProgress	Сводка хода выполнения запланированного задания.
PropertyJobData	Определение данных задания свойства.

CloudPropertyJobData

Object

Данные задания облачного свойства.

Имя	Тип	Описание
path	string	Путь к целевой возможности в шаблоне устройства.
target	string minLength: 1	Шаблон устройства, определяющий целевую возможность задания.
type	string: cloudProperty	Тип данных задания.
value	AnyValue	Значение, используемое для обновления целевой возможности, если таковой имеется.

CommandJobData

Object

Определение данных задания команды.

Имя	Тип	Описание
path	string	Путь к целевой возможности в шаблоне устройства.
target	string minLength: 1	Шаблон устройства, определяющий целевую возможность задания.
type	string: command	Тип данных задания.
value	AnyValue	Значение, используемое для обновления целевой возможности, если таковой имеется.

DeviceTemplateMigrationJobData

Object

Определение данных задания миграции шаблона устройства.

Имя	Тип	Описание
template	string minLength: 1	Шаблон целевого устройства, на который будут перенесены устройства.
type	string: deviceTemplateMigration	Тип данных задания.

Error

Object

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

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

ErrorDetails

Object

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

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

Job

Object

Определение задания.

Имя	Тип	Описание
batch	JobBatch	Конфигурация пакетной обработки для задания.
cancellationThreshold	JobCancellationThreshold	Порог отмены задания.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Возможности, обновляемые заданием и значениями, с помощью которых они обновляются.
description	string	Подробное описание задания.
displayName	string	Отображаемое имя задания.
end	string (date-time)	Время окончания задания
group	string	Идентификатор группы устройств, в которой выполняется задание.
id	string	Уникальный идентификатор задания.
organizations	string[]	Список организаций задания поддерживается только одной организацией сегодня, несколько организаций будут поддерживаться в ближайшее время.
progress	JobProgress	Статистика хода выполнения задания.
scheduledJobId	string	Идентификатор определения запланированного задания, создавшего это задание.
start	string (date-time)	Время начала задания
status	string	Указывает, запускается ли задание, выполняется и т. д.

JobBatch

Object

Определение пакетной службы задания.

Имя	Тип	Описание
type	JobBatchType	Выполняется ли пакетная обработка на указанном количестве устройств или в процентах от общего числа устройств.
value	number	Число или процент устройств, на которых выполняется пакетная обработка.

JobBatchType

Перечисление

Выполняется ли пакетная обработка на указанном количестве устройств или в процентах от общего числа устройств.

Значение	Описание
number	Пакетная обработка заданий на основе количества устройств.
percentage	Процент пакетной обработки заданий на основе общего количества примененных устройств.

JobCancellationThreshold

Object

Определение порогового значения отмены задания.

Имя	Тип	Описание
batch	boolean	Применяется ли порог отмены для каждого пакета или к общему заданию.
type	JobCancellationThresholdType	Указывает, соответствует ли пороговое значение отмены заданному количеству устройств или проценту от общего числа устройств.
value	number	Число или процент устройств, на которых применяется порог отмены.

JobCancellationThresholdType

Перечисление

Указывает, соответствует ли пороговое значение отмены заданному количеству устройств или проценту от общего числа устройств.

Значение	Описание
number	Порог отмены задания на основе указанного количества устройств.
percentage	Порог отмены задания на основе процента от общего числа устройств.

JobProgress

Object

Сводка хода выполнения запланированного задания.

Имя	Тип	Описание
completed	integer (int32)	Количество сущностей, для которых выполнено задание.
failed	integer (int32)	Количество сущностей, для которых задание завершилось сбоем.
pending	integer (int32)	Количество сущностей, для которых задание еще не запущено.
total	integer (int32)	Общее количество сущностей, предназначенных для задания.

PropertyJobData

Object

Определение данных задания свойства.

Имя	Тип	Описание
path	string	Путь к целевой возможности в шаблоне устройства.
target	string minLength: 1	Шаблон устройства, определяющий целевую возможность задания.
type	string: property	Тип данных задания.
value	AnyValue	Значение, используемое для обновления целевой возможности, если таковой имеется.