Job Scheduler - Get Item Job Instance
1 つの項目のジョブ インスタンスを取得します。
必要な委任されたスコープ
項目 API の場合は、次のスコープの種類を使用します。
- 汎用スコープ: Item.ReadWrite.All または Item.Read.All
- 特定のスコープ: itemType。ReadWrite.All または itemType。Read.All (例: Notebook.ReadWrite.All)
スコープの詳細については、スコープに関する記事を参照してください。
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| アイデンティティ | 支援 |
|---|---|
| ユーザー | イエス |
| サービス プリンシパルとマネージド ID | イエス |
インターフェイス
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/instances/{jobInstanceId}URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
item
|
path | True |
string (uuid) |
アイテム ID。 |
|
job
|
path | True |
string (uuid) |
ジョブ インスタンス ID。 |
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は正常に完了しました。 |
|
| Other Status Codes |
一般的なエラー コード:
|
例
Get item job instance example
要求のサンプル
GET 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
応答のサンプル
{
"id": "f2d65699-dd22-4889-980c-15226deb0e1b",
"itemId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "DefaultJob",
"invokeType": "Manual",
"status": "Completed",
"rootActivityId": "8c2ee553-53a4-7edb-1042-0d8189a9e0ca",
"startTimeUtc": "2023-04-22T06:35:00.7812154",
"endTimeUtc": "2023-04-22T06:35:00.8033333",
"failureReason": null
}定義
| 名前 | 説明 |
|---|---|
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Invoke |
項目ジョブ呼び出しの種類。 追加の invokeType は、時間の経過と同時に追加される場合があります。 |
|
Item |
項目ジョブ インスタンスを表すオブジェクト |
| Status |
アイテム ジョブの状態。 追加の状態は、時間の経過と同時に追加される場合があります。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
InvokeType
項目ジョブ呼び出しの種類。 追加の invokeType は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Manual |
ジョブが手動で呼び出される |
| Scheduled |
ジョブがスケジュールされている |
ItemJobInstance
項目ジョブ インスタンスを表すオブジェクト
| 名前 | 型 | 説明 |
|---|---|---|
| endTimeUtc |
string |
ジョブの終了時刻 (UTC) |
| failureReason |
ジョブが失敗したときのエラー応答 |
|
| id |
string (uuid) |
ジョブ インスタンス ID |
| invokeType |
項目ジョブ呼び出しの種類。 追加の invokeType は、時間の経過と同時に追加される場合があります。 |
|
| itemId |
string (uuid) |
アイテム ID |
| jobType |
string |
職務タイプ |
| rootActivityId |
string |
サービス間で要求をトレースするルート アクティビティ ID |
| startTimeUtc |
string |
ジョブの開始時刻 (UTC) |
| status |
アイテム ジョブの状態。 追加の状態は、時間の経過と同時に追加される場合があります。 |
Status
アイテム ジョブの状態。 追加の状態は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Cancelled |
ジョブが取り消されました |
| Completed |
ジョブが完了しました |
| Deduped |
同じジョブの種類のジョブ インスタンスが既に実行されており、このジョブ インスタンスはスキップされます |
| Failed |
ジョブが失敗しました |
| InProgress |
進行中のジョブ |
| NotStarted |
ジョブが開始されていません |