Job Scheduler - Get Item Job Instance
获取一个项目的作业实例。
所需的委派范围
对于项 API，请使用以下范围类型：
- 泛型范围：Item.ReadWrite.All 或 Item.Read.All
- 特定范围：itemType。ReadWrite.All 或 itemType。Read.All（例如：Notebook.ReadWrite.All）
有关范围的详细信息，请参阅 范围文章。
Microsoft Entra 支持的标识
此 API 支持本节中列出的Microsoft 标识。
| 身份 | 支持 |
|---|---|
| 用户 | 是的 |
| 服务主体和托管标识 | 是的 |
接口
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 |
表示项作业实例的对象 |
|
Item |
项作业状态。 可能会随着时间的推移添加其他状态。 |
ErrorRelatedResource
与错误相关的资源详细信息对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| resourceId |
string |
错误中涉及的资源 ID。 |
| resourceType |
string |
错误中涉及的资源的类型。 |
ErrorResponse
错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| moreDetails |
其他错误详细信息的列表。 |
|
| relatedResource |
与错误相关的资源详细信息。 |
|
| requestId |
string |
与错误关联的请求的 ID。 |
ErrorResponseDetails
错误响应详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| relatedResource |
与错误相关的资源详细信息。 |
InvokeType
项作业调用类型。 可能会随着时间的推移添加其他 invokeType。
| 值 | 说明 |
|---|---|
| Scheduled |
作业已计划 |
| Manual |
手动调用作业 |
ItemJobInstance
表示项作业实例的对象
| 名称 | 类型 | 说明 |
|---|---|---|
| endTimeUtc |
string |
UTC 格式的作业结束时间 |
| failureReason |
作业失败时出现错误响应 |
|
| id |
string (uuid) |
作业实例 ID |
| invokeType |
项作业调用类型。 可能会随着时间的推移添加其他 invokeType。 |
|
| itemId |
string (uuid) |
项 ID |
| jobType |
string |
工作类型 |
| rootActivityId |
string |
用于跨服务跟踪请求的根活动 ID |
| startTimeUtc |
string |
作业开始时间（UTC） |
| status |
项作业状态。 可能会随着时间的推移添加其他状态。 |
ItemJobStatus
项作业状态。 可能会随着时间的推移添加其他状态。
| 值 | 说明 |
|---|---|
| NotStarted |
作业未启动 |
| InProgress |
正在进行的作业 |
| Completed |
作业已完成 |
| Failed |
作业失败 |
| Cancelled |
作业已取消 |
| Deduped |
同一作业类型的作业实例已运行，并且跳过此作业实例 |