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

Job Scheduler - Run On Demand Item Job

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

Запустите экземпляр задания элемента по запросу.

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

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

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

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

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

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

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances?jobType={jobType}

Параметры URI

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

string (uuid)

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

string (uuid)

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

string

Тип вакансии

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

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

object

Полезные данные для выполнения запроса задания по запросу на запрос. Требуется только в том случае, если тип задания требует полезных данных.

Ответы

Имя Тип Описание
202 Accepted

Запрос принят, выполнение задания выполняется.

Заголовки

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

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

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

  • InvalidJobType — запрошенный тип задания недопустим.

  • TooManyRequestsForJobs — вызывающий запрос запрашивает слишком много запросов задания по запросу.

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

Примеры

Run item job instance with no request body example
Run item job instance with request body containing executionData example

Run item job instance with no request body example

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

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=DefaultJob

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

Код состояния:
202 
Location: 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
Retry-After: 60

Run item job instance with request body containing executionData example

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

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=DefaultJob

{
  "executionData": {
    "tableName": "Table1",
    "optimizeSettings": {
      "vOrder": true
    }
  }
}

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

Код состояния:
202 
Location: 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
Retry-After: 60

Определения

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

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

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

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

Выполнение полезных данных экземпляра задания элемента запроса

ErrorRelatedResource

Object

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

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

string

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

string

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

ErrorResponse

Object

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

Object

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

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

string

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

string

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

ErrorRelatedResource

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

RunOnDemandItemJobRequest

Object

Выполнение полезных данных экземпляра задания элемента запроса

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

object

Полезные данные для выполнения запроса задания по запросу на запрос. Требуется только в том случае, если тип задания требует полезных данных.