Job Scheduler - Cancel Item Job Instance

サービス:

Core

API バージョン:

v1

アイテムのジョブ インスタンスを取り消します。

必要な委任されたスコープ

項目 API の場合は、次のスコープの種類を使用します。

• 汎用スコープ: Item.Execute.All
• 特定のスコープ: itemType。Execute.All (例: Notebook.Execute.All)

スコープの詳細については、スコープに関する記事を参照してください。

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	支援
ユーザー	イエス
サービス プリンシパルとマネージド ID	イエス

インターフェイス

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

要求のサンプル

HTTP

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	エラー関連のリソースの詳細。