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

Background Jobs - Run On Demand Execute

  • Ссылка
Служба:
Dataflow
Версия API:
v1

Замечание

Доступна предварительная версия этого API.

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

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

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

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

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

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

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

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

Интерфейс

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

Параметры URI

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

string (uuid)

Идентификатор потока данных.
workspaceId
 path True

string (uuid)

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

string

Выполнение типа задания. Обновление также можно использовать в качестве псевдонима для Execute.

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

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

DataflowExecutionPayload

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

Ответы

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

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

Заголовки

  • Location: string
  • 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

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

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

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

Код состояния:
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

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

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

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

Object

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

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

ExecuteOption

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

ItemJobParameter[]

Список параметров для переопределения во время выполнения.

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

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

ExecuteOption

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

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

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

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

Значение по умолчанию. Операция "Применить изменения" пропускается.

ItemJobParameter

Object

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

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

string

Имя параметра.
type

Type

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

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

RunOnDemandDataflowExecuteJobRequest

Object

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

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

DataflowExecutionPayload

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

Type

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

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

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

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