Jobs - Cancel Item Job Instance

服务:

Workload Development

API 版本:

v1

由 Microsoft Fabric 调用以取消作业实例。
Fabric 执行基本验证并调用此 API 以取消工作负荷中的项作业实例。

此 API 应接受 SubjectAndApp 身份验证。

权限

Microsoft Fabric 检查权限。

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}/jobTypes/{jobType}/instances/{jobInstanceId}/cancel

URI 参数

名称	在	必需	类型	说明
itemId	path	True	string uuid	项 ID。
itemType	path	True	string	项类型。
jobInstanceId	path	True	string uuid	作业实例 ID。
jobType	path	True	string	作业类型。
workspaceId	path	True	string uuid	工作区 ID。

请求头

名称	必需	类型	说明
ActivityId	True	string	当用户与工作负荷交互时，用于将请求与系统相关联的唯一 ID。
RequestId	True	string	一个全局唯一 ID，可帮助 Fabric 将请求与我们的日志相关联。 报告问题时提供此 ID。
Authorization	True	string	一个双令牌授权标头，允许工作负荷验证请求源、提供用户上下文和调用其他服务。 此标头的格式如下：SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"。
x-ms-client-tenant-id	True	string	发出请求的客户端的租户 ID。

响应

名称	类型	说明
200 OK	ItemJobInstanceState	成功完成。
Other Status Codes	ErrorResponse	对于错误条件，工作负荷应返回相应的 HTTP 错误状态代码（4xx，5xx），并在响应正文中返回详细的错误信息。

示例

Cancel item job instance example

示例请求

HTTP

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111/jobTypes/calculateForecast/instances/63f77191-432d-4ee6-9c5f-31a1a6987072/cancel

示例响应

状态代码:

200

{
  "status": "Cancelled",
  "startTimeUtc": "2023-12-10T14:41:39.412Z",
  "endTimeUtc": "2023-12-10T14:47:29.709Z"
}

定义

名称	说明
ErrorDetails	错误详细信息。
ErrorExtendedInformation	扩展的错误信息。
ErrorResponse	错误响应。
ErrorSource	错误的源。
ItemJobInstanceState	作业实例状态。
JobInstanceStatus	项作业实例的状态。
NameValuePair	名称值对。

ErrorDetails

Object

错误详细信息。

名称	类型	说明
errorCode	string	错误代码。
isPermanent	boolean	指示错误是永久性的，还是可以重试作。
message	string	错误消息。
messageParameters	string[]	用于设置本地化消息格式的参数列表。
moreDetails	ErrorExtendedInformation[]	其他错误详细信息的列表。
source	ErrorSource	错误源。

ErrorExtendedInformation

Object

扩展的错误信息。

名称	类型	说明
additionalParameters	NameValuePair[]	特定于错误的其他参数的列表。
errorCode	string	错误代码。
message	string	错误消息。
messageParameters	string[]	用于设置本地化消息格式的参数列表。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	错误代码。
isPermanent	boolean	指示错误是永久性的，还是可以重试作。
message	string	错误消息。
messageParameters	string[]	用于设置本地化消息格式的参数列表。
moreDetails	ErrorExtendedInformation[]	其他错误详细信息的列表。
source	ErrorSource	错误源。

ErrorSource

Enumeration

错误的源。

值	说明
External
System
User

ItemJobInstanceState

Object

作业实例状态。

名称	类型	说明
endTimeUtc	string date-time	作业实例结束时间。
errorDetails	ErrorDetails	作业实例失败时的错误详细信息。
startTimeUtc	string date-time	作业实例开始时间。
status	JobInstanceStatus	作业实例的状态。

JobInstanceStatus

Enumeration

项作业实例的状态。

值	说明
Cancelled
Completed
Failed
InProgress
NotStarted

NameValuePair

Object

名称值对。

名称	类型	说明
name	string	名称。
value	string	值。