Background Jobs - Run On Demand Execute

Служба:: Dataflow

Версия API:: v1

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

Note

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

Permissions

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

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

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

Конкретная область: Dataflow.Execute.All

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

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

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

Identity	Support
User	Yes
Представитель службы и управляемые удостоверения	No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/execute/instances

Параметры URI

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

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

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

Ответы

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

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 dataflow Execute job instance with no request body example

Run dataflow Execute job instance with request body containing parameters example

Run dataflow Execute job instance with no request body example

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

HTTP

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

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

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

Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Run dataflow Execute job instance with request body containing parameters example

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

HTTP

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

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

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

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

Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Определения

Имя	Описание
DataflowExecutionPayload	Полезные данные выполнения для потока данных
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ExecuteOption	Параметры выполнения операции. Дополнительные операции executeOptions могут быть добавлены с течением времени.
ItemJobParameter	Сведения о параметрах.
RunOnDemandDataflowExecuteJobRequest	Выполнение по запросу полезных данных экземпляра задания потока данных
Type	Тип параметра. С течением времени могут добавляться дополнительные типы параметров.

DataflowExecutionPayload

Объект

Полезные данные выполнения для потока данных

Имя	Тип	Описание
executeOption	ExecuteOption	Параметры выполнения операции. Дополнительные операции executeOptions могут быть добавлены с течением времени.
parameters	ItemJobParameter[]	Список параметров для переопределения во время выполнения.

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

ExecuteOption

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

Параметры выполнения операции. Дополнительные операции executeOptions могут быть добавлены с течением времени.

Значение	Описание
SkipApplyChanges	Значение по умолчанию. Операция "Применить изменения" пропускается.
ApplyChangesIfNeeded	При необходимости выполняется операция "Изменения приложения". Можно использовать, если для выполнения требуются последние изменения.

ItemJobParameter

Объект

Сведения о параметрах.

Имя	Тип	Описание
parameterName	string	Имя параметра.
type	Type	Тип параметра. С течением времени могут добавляться дополнительные типы параметров.
value	object	Значение параметра для переопределения во время выполнения.

RunOnDemandDataflowExecuteJobRequest

Объект

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

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

Type

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

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

Значение	Описание
Automatic	Значение должно быть автоматическим