Long Running Operations - Get Operation State
返回长时间运行的作的当前状态。
从启动作的 API 返回的 x-ms-operation-id 标头中获取 operationId。
作状态为“成功”后，使用 “获取作结果 API ”检索结果。
权限
与启动作的 API 所需的权限相同。
所需的委托范围
与启动作的 API 所需的范围相同。
Microsoft Entra 支持的标识
此 API 支持本节中列出的Microsoft 标识。
| 身份 | 支持 |
|---|---|
| 用户 | 是的 |
| 服务主体和托管标识 | 是的 |
接口
GET https://api.fabric.microsoft.com/v1/operations/{operationId}URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
operation
|
path | True |
string (uuid) |
操作 ID |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
请求成功完成。 标头
|
|
| Other Status Codes |
常见错误代码：
|
示例
| Get active long running operation example |
| Get completed long running operation example |
Get active long running operation example
示例请求
GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
示例响应
Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 20{
"status": "Running",
"createdTimeUtc": "2023-09-13T14:56:18.477Z",
"lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
"percentComplete": 25
}Get completed long running operation example
示例请求
GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
示例响应
Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227/result
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227{
"status": "Succeeded",
"createdTimeUtc": "2023-09-13T14:56:18.477Z",
"lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
"percentComplete": 100
}定义
| 名称 | 说明 |
|---|---|
|
Error |
与错误相关的资源详细信息对象。 |
|
Error |
错误响应。 |
|
Error |
错误响应详细信息。 |
|
Long |
作的当前状态。 可能会随着时间的推移添加其他作状态。 |
|
Operation |
描述长时间运行作的详细信息和当前状态的对象 |
ErrorRelatedResource
与错误相关的资源详细信息对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| resourceId |
string |
错误中涉及的资源 ID。 |
| resourceType |
string |
错误中涉及的资源的类型。 |
ErrorResponse
错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| moreDetails |
其他错误详细信息的列表。 |
|
| relatedResource |
与错误相关的资源详细信息。 |
|
| requestId |
string |
与错误关联的请求的 ID。 |
ErrorResponseDetails
错误响应详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| relatedResource |
与错误相关的资源详细信息。 |
LongRunningOperationStatus
作的当前状态。 可能会随着时间的推移添加其他作状态。
| 值 | 说明 |
|---|---|
| Undefined |
作的状态未定义 |
| NotStarted |
作未启动 |
| Running |
作正在运行 |
| Succeeded |
作已成功完成 |
| Failed |
作失败 |
OperationState
描述长时间运行作的详细信息和当前状态的对象
| 名称 | 类型 | 说明 |
|---|---|---|
| createdTimeUtc |
string (date-time) |
作的开始日期和时间 |
| error |
作处于失败状态时的错误详细信息 |
|
| lastUpdatedTimeUtc |
string (date-time) |
上次更改作的日期和时间 |
| percentComplete |
integer (int32) minimum: 0maximum: 100 |
作进度百分比 |
| status |
作的当前状态。 可能会随着时间的推移添加其他作状态。 |