Analyze Documents Cancel Job - Analyze Documents Cancel Job

Serviço:

Azure AI Services

Versão da API:

2026-05-01

Cancele um trabalho de Análise de Texto de longa duração.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	O ID do trabalho a ser cancelado.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

SuccessfulAnalyzeDocumentsJobsCancelRequest

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

202

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

Definições

Name	Description
Error	O objeto de resposta de erro retornado quando o serviço encontra alguns erros durante o processamento da solicitação.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Object

O objeto de resposta de erro retornado quando o serviço encontra alguns erros durante o processamento da solicitação.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválida
InvalidArgument	Erro de argumento inválido
Unauthorized	Erro de acesso não autorizado
Forbidden	Erro de acesso proibido
NotFound	Erro não encontrado
ProjectNotFound	Project não encontrado erro
OperationNotFound	Erro de operação não encontrado
AzureCognitiveSearchNotFound	Azure Cognitive Search erro não encontrado
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search index erro não encontrado
TooManyRequests	Erro de muitas solicitações
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search index limite reached error
InternalServerError	Erro interno do servidor
ServiceUnavailable	Erro de serviço indisponível
Timeout	Erro de tempo limite
QuotaExceeded	Erro de quota excedida
Conflict	Erro de conflito
Warning	Erro de aviso

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválida
InvalidParameterValue	Erro de valor de parâmetro inválido
KnowledgeBaseNotFound	Erro não encontrado na base de dados de conhecimento
AzureCognitiveSearchNotFound	Azure Cognitive Search erro não encontrado
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
ExtractionFailure	Erro de falha de extração
InvalidRequestBodyFormat	Erro de formato de corpo de solicitação inválido
EmptyRequest	Erro de solicitação vazia
MissingInputDocuments	Erro de documentos de entrada ausentes
InvalidDocument	Erro de documento inválido
ModelVersionIncorrect	Erro de versão incorreta do modelo
InvalidDocumentBatch	Erro de lote de documento inválido
UnsupportedLanguageCode	Erro de código de idioma não suportado
InvalidCountryHint	Erro de dica de país inválido

InnerErrorModel

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Alvo de erro.