Job Scheduler - Run On Demand Item Job

Служба:: Core

Версия API:: v1

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

Замечание

URL-адрес этого API был обновлен, чтобы включить тип задания в рамках пути, заменив предыдущее использование параметра запроса. Для обратной совместимости вызовы с помощью параметра запроса по-прежнему поддерживаются.

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

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

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

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

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

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

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

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
itemId	path	True	string (uuid)	Идентификатор элемента.
jobType	path	True	string	Тип вакансии
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

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

Имя	Тип	Описание
executionData	object	Данные выполнения для задания по запросу. Это исправлено статические данные, определенные определенным типом задания элемента.
parameters	Parameter[]	Список параметров для задания по запросу. Это определяемые пользователем входные данные для каждого запуска, которые настраивают этот вызов. Примечание. Это свойство широко не поддерживается. Если API возвращает ошибку с errorCode `FeatureNotAvailable` и errorMessage `Parameter is not allowed for this item type or this item job type`, `parameters` свойство не поддерживается для указанного типа элемента или типа задания элемента.

Ответы

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

202 Accepted

Имя	Тип	Описание
202 Accepted		Запрос принят, выполнение задания выполняется. Заголовки: Расположение`string` — URL-адрес ресурса экземпляра задания. Повторная попытка после`integer` — Количество секунд, которые клиент должен ждать, прежде чем опрашивание состояния задания в первый раз. Клиенты должны использовать это значение, чтобы определить, когда проверять состояние задания и ждать по крайней мере это много секунд до первого опроса состояния.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений для запуска экземпляра задания. InvalidJobType — запрошенный тип задания недопустим. TooManyRequestsForJobs — вызывающий запрос запрашивает слишком много запросов задания по запросу. ItemNotFound — запрошенный идентификатор элемента не найден.

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

Заголовки:

Расположениеstring — URL-адрес ресурса экземпляра задания.

Повторная попытка послеinteger — Количество секунд, которые клиент должен ждать, прежде чем опрашивание состояния задания в первый раз. Клиенты должны использовать это значение, чтобы определить, когда проверять состояние задания и ждать по крайней мере это много секунд до первого опроса состояния.

429 Too Many Requests

ErrorResponse

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

Заголовки

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 both executionData and parameters example

Run item job instance with request body containing executionData example

Run item job instance with request body containing parameters example

Run item job instance with no request body example

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

HTTP

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

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

Код состояния:: 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 both executionData and parameters example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

{
  "executionData": {
    "executeOption": "ApplyChangesIfNeeded"
  },
  "parameters": [
    {
      "name": "Threshold",
      "value": "start",
      "type": "Automatic"
    },
    {
      "name": "OrderKey",
      "value": 25,
      "type": "Automatic"
    }
  ]
}

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

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

Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute
Retry-After: 60

Run item job instance with request body containing executionData example

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

HTTP

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

{
  "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

Run item job instance with request body containing parameters example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

{
  "parameters": [
    {
      "name": "param1",
      "value": "value1",
      "type": "Text"
    },
    {
      "name": "param2",
      "value": true,
      "type": "Boolean"
    },
    {
      "name": "param3",
      "value": 123,
      "type": "Number"
    }
  ]
}

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

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

Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute
Retry-After: 60

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ItemJobParameterType	Строка, представляющая тип параметра. С течением времени могут добавляться дополнительные типы.
Parameter	Параметр задания элемента.
RunOnDemandItemJobRequest	Выполнение полезных данных экземпляра задания элемента запроса

ErrorRelatedResource

Объект

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

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

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

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

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

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

ItemJobParameterType

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

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

Значение	Описание
VariableReference	Тип параметра — это ссылка на переменную.
Integer	Тип параметра — целое число.
Number	Тип параметра — это число, оно принимает как целочисленные, так и значения с плавающей запятой.
Text	Тип параметра — это текст.
Boolean	Тип параметра является логическим.
DateTime	Тип параметра — это дата и время в формате UTC, используя формат ггГГ-ММ-ДДTHH:мм:ssZ.
Guid	Тип параметра — это строковое представление GUID, используя формат 00000000000-0000-0000-0000-00000000000000. Дополнительные сведения о форматировании см https://learn.microsoft.com/dotnet/api/system.guid.tostring . в формате по умолчанию: "D".
Automatic	Тип параметра определяется автоматически. Примечание. Этот тип может не поддерживаться для всех типов заданий элементов.

Parameter

Объект

Параметр задания элемента.

Имя	Тип	Описание
name	string	Имя параметра, указанное вызывающим оператором, должно быть уникальным (без учета регистра) и не более 256 символов.
type	ItemJobParameterType	Тип параметра.
value	object	Значение параметра на основе типа параметра.

RunOnDemandItemJobRequest

Объект

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

Имя	Тип	Описание
executionData	object	Данные выполнения для задания по запросу. Это исправлено статические данные, определенные определенным типом задания элемента.
parameters	Parameter[]	Список параметров для задания по запросу. Это определяемые пользователем входные данные для каждого запуска, которые настраивают этот вызов. Примечание. Это свойство широко не поддерживается. Если API возвращает ошибку с errorCode `FeatureNotAvailable` и errorMessage `Parameter is not allowed for this item type or this item job type`, `parameters` свойство не поддерживается для указанного типа элемента или типа задания элемента.