Background Jobs - Run On Demand Execute

注释

此 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)

数据流 ID。

workspaceId
path True

string (uuid)

工作区 ID。

jobType
query True

string

执行 作业类型。 刷新 还可以用作 Execute 的别名。

请求正文

名称 类型 说明
executionData

DataflowExecutionPayload

运行按需执行作业请求的有效负载。 仅当数据流已启用参数化时才需要。

响应

名称 类型 说明
202 Accepted

请求已接受,作业执行正在进行中。

标头

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

ErrorResponse

常见错误代码:

  • InsufficientPrivileges - 调用方没有足够的权限来运行作业实例。

  • InvalidJobType - 请求的作业类型无效。

  • TooManyRequestsForJobs - 调用方请求过多的按需作业请求。

  • ItemNotFound - 找不到请求的项目 ID。

示例

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

示例响应

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"
      }
    ]
  }
}

示例响应

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

错误中涉及的资源 ID。

resourceType

string

错误中涉及的资源的类型。

ErrorResponse

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符,允许服务与其用户之间的标准化通信。

message

string

错误的人工可读表示形式。

moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。

relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符,允许服务与其用户之间的标准化通信。

message

string

错误的人工可读表示形式。

relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

ExecuteOption

用于运行执行作的选项。 可能会随着时间的推移添加其他 executeOptions。

说明
ApplyChangesIfNeeded

如果需要,将执行 Appply Changes作。 当执行需要最新更改时,可以使用。

SkipApplyChanges

默认值。 跳过“应用更改”作。

ItemJobParameter

参数详细信息。

名称 类型 说明
parameterName

string

参数的名称。

type

Type

参数类型。 可能会随着时间的推移添加其他参数类型。

value

在执行期间要重写的参数的值。

RunOnDemandDataflowExecuteJobRequest

按需运行执行数据流作业实例有效负载

名称 类型 说明
executionData

DataflowExecutionPayload

运行按需执行作业请求的有效负载。 仅当数据流已启用参数化时才需要。

Type

参数类型。 可能会随着时间的推移添加其他参数类型。

说明
Automatic

值必须是自动值