你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Miscellaneous - List Operations

参考

Service:: Azure AI Services

API Version:: 2022-08-31

Lists所有操作。

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点 (协议和主机名，例如： https://westus2.api.cognitive.microsoft.com) 。
api-version	query	True	ApiVersion	请求的 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

响应

名称	类型	说明
200 OK	GetOperationsResponse	没问题。
Other Status Codes	ErrorResponse	遇到错误。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

GetOperations

Sample Request

HTTP

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Sample Response

Status code:: 200

{
  "value": [
    {
      "operationId": "{operationId}",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

定义

名称	说明
ApiVersion	API 版本。
Error	错误信息。
ErrorResponse	错误响应对象。
GetOperationsResponse	List Operations 响应对象。
InnerError	详细错误。
OperationKind	操作的类型。
OperationStatus	操作状态。
OperationSummary	操作信息。

ApiVersion

API 版本。

名称	类型	说明
2022-08-31	string

Error

错误信息。

名称	类型	说明
code	string	错误代码。
details	Error[]	详细错误列表。
innererror	InnerError	详细错误。
message	string	错误消息。
target	string	错误的目标。

ErrorResponse

错误响应对象。

名称	类型	说明
error	Error	错误信息。

GetOperationsResponse

List Operations 响应对象。

名称	类型	说明
nextLink	string	链接到操作的下一页。
value	OperationSummary[]	操作列表。

InnerError

详细错误。

名称	类型	说明
code	string	错误代码。
innererror	InnerError	详细错误。
message	string	错误消息。

OperationKind

操作的类型。

名称	类型	说明
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

操作状态。

名称	类型	说明
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OperationSummary

操作信息。

名称	类型	说明
apiVersion	string	用于创建此操作的 API 版本。
createdDateTime	string	创建操作时 (UTC) 日期和时间。
kind	OperationKind	操作的类型。
lastUpdatedDateTime	string	上次更新状态时 (UTC) 日期和时间。
operationId	string	Operation ID
percentCompleted	integer	操作进度 (0-100) 。
resourceLocation	string	此操作所面向的资源的 URL。
status	OperationStatus	操作状态。
tags	object	与文档模型关联的键值标记属性的列表。

通过