通过

Job Scheduler - Run On Demand Item Job

服务:
Core
API 版本:
v1

运行按需项作业实例。

注释

此 API 的 URL 已更新，以将作业类型作为路径的一部分包含在内，并替换了以前使用的查询参数。 为了向后兼容，仍支持使用查询参数的调用。

所需的委派范围

对于项 API，请使用以下范围类型：

  • 泛型范围：Item.Execute.All
  • 特定范围： itemType。Execute.All（例如：Notebook.Execute.All）

有关范围的详细信息，请参阅：范围文章。

Microsoft Entra支持的标识

此 API 支持本节中列出的 Microsoft identities。

身份 支持
用户 是的
服务主体和托管标识 是的

接口

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

URI 参数

名称 在 必需 类型 说明
itemId
 path True

string (uuid)

项 ID。
jobType
 path True

string

工作类型
workspaceId
 path True

string (uuid)

工作区 ID。

请求正文

名称 类型 说明
executionData

object

按需作业的执行数据。 这是由特定项作业类型定义的固定静态数据。
parameters

Parameter[]

按需作业的参数列表。 这些是按运行的用户定义输入，用于定制此调用。 注意：此属性不受广泛支持。 如果 API 返回 errorCode FeatureNotAvailable 和 errorMessage Parameter is not allowed for this item type or this item job type错误，则 parameters 指定的项类型或项作业类型不支持该属性。

响应

名称 类型 说明
202 Accepted

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

标头：

位置string - 作业实例资源的 URL。

Retry-Afterinteger - 客户端应在首次轮询作业状态之前等待的秒数。 客户端必须使用此值来确定何时检查作业状态，并且应在第一次状态轮询之前至少等待此秒。
429 Too Many Requests

ErrorResponse

超出服务速率限制。 服务器返回一个 Retry-After 标头，指示客户端在发送其他请求之前必须等待的时间（以秒为单位）。

标头

Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

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

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

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

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

示例

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

示例请求

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

示例请求

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

示例请求

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

示例请求

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

错误中涉及的资源 ID。
resourceType

string

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

ErrorResponse

对象

错误响应。

名称 类型 说明
errorCode

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string (uuid)

与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称 类型 说明
errorCode

string

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

string

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

ErrorRelatedResource

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

ItemJobParameterType

枚举

一个表示参数类型的字符串。 可能会随着时间的推移添加其他类型。

值 说明
VariableReference

参数的类型是变量引用。
Integer

参数的类型为整数。
Number

参数的类型是一个数字，它接受整数和浮点值。
Text

参数的类型为文本。
Boolean

参数的类型为布尔值。
DateTime

参数的类型是 UTC 格式的日期时间，使用 YYYY-MM-DDTHH：mm：ssZ 格式。
Guid

参数类型是 GUID 的字符串表示形式，使用 0000000-0000-0000-0000-000000000000000 格式。 有关 https://dotnet.territoriali.olinfo.it/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 指定的项类型或项作业类型不支持该属性。