Analyze Documents Cancel Job - Analyze Documents Cancel Job

服务:

Azure AI Services

API 版本:

2026-05-01

取消长时间运行的文本分析作业。

POST {Endpoint}/language/analyze-documents/jobs/{jobId}:cancel?api-version=2026-05-01

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如，https://< resource-name.api.cognitiveservices.azure.com>）。
jobId	path	True	string (uuid)	要取消的作业 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。 标头 Operation-Location: string
Other Status Codes	ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

SuccessfulAnalyzeDocumentsJobsCancelRequest

示例请求

HTTP

POST {Endpoint}/language/analyze-documents/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18:cancel?api-version=2026-05-01

示例响应

状态代码:

202

Operation-Location: {Endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2026-05-01

定义

名称	说明
Error	当服务在处理请求期间遇到一些错误时返回的错误响应对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据Microsoft One API指南——https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

Error

对象

当服务在处理请求期间遇到一些错误时返回的错误响应对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidArgument	参数错误无效
Unauthorized	未经授权的访问错误
Forbidden	禁止访问错误
NotFound	找不到错误
ProjectNotFound	Project 未找到错误
OperationNotFound	找不到操作错误
AzureCognitiveSearchNotFound	Azure 认知搜索 未找到错误
AzureCognitiveSearchIndexNotFound	Azure 认知搜索 索引未找到错误
TooManyRequests	请求过多错误
AzureCognitiveSearchThrottling	Azure 认知搜索 throttling error
AzureCognitiveSearchIndexLimitReached	Azure 认知搜索 index limit reached error（达到错误）
InternalServerError	内部服务器错误
ServiceUnavailable	服务不可用错误
Timeout	超时错误
QuotaExceeded	超出配额错误
Conflict	冲突错误
Warning	警告错误

ErrorResponse

对象

错误响应。

名称	类型	说明
error	Error	错误对象。

InnerErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidParameterValue	参数值错误无效
KnowledgeBaseNotFound	知识库找不到错误
AzureCognitiveSearchNotFound	Azure 认知搜索 未找到错误
AzureCognitiveSearchThrottling	Azure 认知搜索 throttling error
ExtractionFailure	提取失败错误
InvalidRequestBodyFormat	请求正文格式错误无效
EmptyRequest	空请求错误
MissingInputDocuments	缺少输入文档错误
InvalidDocument	文档错误无效
ModelVersionIncorrect	模型版本错误错误
InvalidDocumentBatch	文档批处理错误无效
UnsupportedLanguageCode	不支持的语言代码错误
InvalidCountryHint	国家/地区提示错误无效

InnerErrorModel

对象

包含有关错误的更具体信息的对象。 根据Microsoft One API指南——https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误消息。
target	string	错误目标。