Job Scheduler - Get Item Job Instance

Служба:
Core
Версия API:
v1

Получение экземпляра задания одного элемента.

Обязательные делегированные области

Для API элементов используются следующие типы областей:

  • Универсальная область: Item.ReadWrite.All или Item.Read.All
  • Конкретная область: itemType. ReadWrite.All или itemType. Read.All (например: Notebook.ReadWrite.All)

Дополнительные сведения об областях см. в статье области.

поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает Майкрософт identities, перечисленных в этом разделе.

Идентичность Поддержка
Пользователь Да
Представитель службы и управляемые удостоверения Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}

Параметры URI

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

string (uuid)

Идентификатор элемента.
jobInstanceId
 path True

string (uuid)

Идентификатор экземпляра задания.
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Ответы

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

ItemJobInstance

Запрос успешно завершен.

Заголовки:

Повторная попытка послеinteger — количество секунд, ожидаемых перед проверкой состояния экземпляра задания.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений для доступа к элементу.

  • ItemNotFound — запрошенный идентификатор элемента не найден.

Примеры

Get item job instance example

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

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b

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

Код состояния:
200 
{
  "id": "f2d65699-dd22-4889-980c-15226deb0e1b",
  "itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
  "jobType": "DefaultJob",
  "invokeType": "Manual",
  "status": "Completed",
  "rootActivityId": "8c2ee553-53a4-7edb-1042-0d8189a9e0ca",
  "startTimeUtc": "2023-04-22T06:35:00.7812154",
  "endTimeUtc": "2023-04-22T06:35:00.8033333",
  "failureReason": null
}

Определения

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

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
InvokeType

Задание элемента вызывает тип. Дополнительные методы invokeTypes могут добавляться с течением времени.
ItemJobInstance

Объект, представляющий экземпляр задания элемента
ItemJobStatus

Состояние задания элемента. С течением времени могут добавляться дополнительные состояния.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

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

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

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

string

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

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

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

string

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

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

InvokeType

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

Задание элемента вызывает тип. Дополнительные методы invokeTypes могут добавляться с течением времени.

Значение Описание
Scheduled

Задание запланировано
Manual

Задание вызывается вручную

ItemJobInstance

Объект

Объект, представляющий экземпляр задания элемента

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

string

Время окончания задания в формате UTC
failureReason

ErrorResponse

Ответ об ошибке при сбое задания
id

string (uuid)

Идентификатор экземпляра задания
invokeType

InvokeType

Задание элемента вызывает тип. Дополнительные методы invokeTypes могут добавляться с течением времени.
itemId

string (uuid)

Идентификатор элемента
jobType

string

Тип вакансии
rootActivityId

string (uuid)

Идентификатор корневого действия для трассировки запросов между службами
startTimeUtc

string

Время начала задания в формате UTC
status

ItemJobStatus

Состояние задания элемента. С течением времени могут добавляться дополнительные состояния.

ItemJobStatus

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

Состояние задания элемента. С течением времени могут добавляться дополнительные состояния.

Значение Описание
NotStarted

Задание не запущено
InProgress

Выполнение задания
Completed

Задание завершено
Failed

Сбой задания
Cancelled

Задание отменено
Deduped

Экземпляр задания того же типа задания уже запущен, и этот экземпляр задания пропускается