通过

Job Scheduler - Cancel Item Job Instance

服务:
Core
API 版本:
v1

取消项的作业实例。

所需的委派范围

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

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

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

Microsoft Entra 支持的标识

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

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

接口

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

URI 参数

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

string (uuid)

项 ID。
jobInstanceId
 path True

string (uuid)

作业实例 ID。
workspaceId
 path True

string (uuid)

工作区 ID。

响应

名称 类型 说明
202 Accepted

请求已接受，正在取消作业。

标头

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

ErrorResponse

常见错误代码：

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

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

  • JobAlreadyCompleted - 无法处理请求的取消，因为作业实例运行已完成。

示例

Cancel item job instance example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/instances/5b218778-e7a5-4d73-8187-f10824047715/cancel

示例响应

状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/instances/5b218778-e7a5-4d73-8187-f10824047715
Retry-After: 60

定义

名称 说明
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。

ErrorRelatedResource

Object

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

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

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

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

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

string

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

ErrorRelatedResource

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