Cancel translation
Reference
Service: Azure AI Document Translation
API Version: v1.1
Cancel a current processing or queued operation. An operation isn't canceled if completed, failed, or canceling. A bad request is returned. Completed translations aren't canceled and are charged. All pending translations are canceled if possible.
Request URL
Send a DELETE
request to:
https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}
Learn how to find your custom domain name.
Important
- All API requests to the Document Translation service require a custom domain endpoint.
- You can't use the endpoint found on your Azure portal resource Keys and Endpoint page nor the global translator endpoint—
api.cognitive.microsofttranslator.com
—to make HTTP requests to Document Translation.
Request parameters
Request parameters passed on the query string are:
Query parameter | Required | Description |
---|---|---|
id |
True | The operation-ID. |
Request headers
Request headers are:
Headers | Description |
---|---|
Ocp-Apim-Subscription-Key | Required request header |
Response status codes
The following are the possible HTTP status codes that a request returns.
Status Code | Description |
---|---|
200 | OK. Cancel request submitted |
401 | Unauthorized. Check your credentials. |
404 | Not found. Resource isn't found. |
500 | Internal Server Error. |
Other Status Codes | • Too many requests • Server temporary unavailable |
Cancel translation response
Successful response
The following information is returned in a successful response.
Name | Type | Description |
---|---|---|
id |
string | ID of the operation. |
createdDateTimeUtc | string | Operation created date time. |
lastActionDateTimeUtc | string | Date time in which the operation's status is updated. |
status | String | List of possible statuses for job or document: • Canceled • Cancelling • Failed • NotStarted • Running • Succeeded • ValidationFailed |
summary | StatusSummary | Summary containing a list of details. |
summary.total | integer | Count of total documents. |
summary.failed | integer | Count of documents failed. |
summary.success | integer | Count of documents successfully translated. |
summary.inProgress | integer | Count of documents in progress. |
summary.notYetStarted | integer | Count of documents not yet started processing. |
summary.cancelled | integer | Number of canceled. |
summary.totalCharacterCharged | integer | Total characters charged by the API. |
Error response
Name | Type | Description |
---|---|---|
code | string | Enums containing high-level error codes. Possible values: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable • Unauthorized |
message | string | Gets high-level error message. |
target | string | Gets the source of the error. For example, it would be "documents" or document id for an invalid document. |
innerError | InnerTranslationError | New Inner Error format that conforms to Azure AI services API Guidelines. This error message contains required properties ErrorCode, message, and optional properties target, details (key value pair), inner error (it can be nested). |
innerError.code | string | Gets code error string. |
innerError.message | string | Gets high-level error message. |
innerError.target | string | Gets the source of the error. For example, it would be documents or document id if there was an invalid document. |
Examples
Example successful response
The following JSON object is an example of a successful response.
Status code: 200
{
"id": "727bf148-f327-47a0-9481-abae6362f11e",
"createdDateTimeUtc": "2020-03-26T00:00:00Z",
"lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
"status": "Succeeded",
"summary": {
"total": 10,
"failed": 1,
"success": 9,
"inProgress": 0,
"notYetStarted": 0,
"cancelled": 0,
"totalCharacterCharged": 0
}
}
Example error response
The following JSON object is an example of an error response. The schema for other error codes is the same.
Status code: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"target": "Operation",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Next steps
Follow our quickstart to learn more about using Document Translation and the client library.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for