通过

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

取消翻译

  • 项目

参考
功能：Azure AI 翻译 →文档翻译
API 版本：2024-05-01
HTTP 方法：DELETE

  • 此方法取消当前正在处理或排队（挂起）的翻译作业，如查询参数在请求 id 中所示。
  • 如果已完成、失败或仍在取消，则不会取消操作。 在这些情况下，将返回错误的请求。
  • 无法取消已完成的翻译并收费。

请求 URL

重要

对文档翻译功能的所有 API 请求都需要位于Azure 门户的资源概述页上的自定义域终结点。

  curl -i -X  DELETE "{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}"

请求参数

查询字符串上传递的请求参数如下：

查询参数 必需 说明
id True 操作 ID。

查找 id 值

可以在 POST start-batch-translation 方法响应标头 Operation-Location URL 值中找到作业id。 参数后面的 /document/ 字母数字字符串是操作的作业 id：

响应头 响应 URL
Operation-Location {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec？api-version=2024-05-01

请求标头

请求标头为：

头文件 说明
Ocp-Apim-Subscription-Key 必需的请求标头

响应状态代码

下面是请求可能返回的 HTTP 状态代码。

状态代码 说明
200 没问题。 取消请求已提交
401 未授权。 检查凭据。
404 未找到。 找不到资源。
500 内部服务器错误。
其他状态代码 • 请求过多
• 服务器暂不可用

取消翻译响应

成功的响应

在成功的响应中返回以下信息。

名称 Type 说明
id 字符串 操作的 ID。
createdDateTimeUtc 字符串 操作创建的日期时间。
lastActionDateTimeUtc string 操作状态发生更新的日期时间。
状态 字符串 作业或文档可能所处状态的列表：• Canceled
• Cancelling
• 失败
• NotStarted
• 正在运行
• 已成功
• ValidationFailed
summary StatusSummary 包含详细信息列表的摘要。
summary.total integer 文档总数。
summary.failed integer 失败的文档数。
summary.success integer 成功翻译的文档数。
summary.inProgress integer 正在进行处理的文档数。
summary.notYetStarted integer 尚未开始处理的文档数。
summary.cancelled integer 已取消的作业计数。
summary.totalCharacterCharged integer API 计费的总字符数。

错误响应

名称 Type 说明
code string 包含错误代码概要的枚举。 可能的值：
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
• 未授权
message 字符串 获取概要错误消息。
目标 string 获取错误的源。 例如，对于无效的文档，会显示“documents”或 document id。
innerError InnerTranslationError 符合 Azure AI 服务 API 准则的新的内部错误格式。 此错误消息包含必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可以嵌套）。
innerError.code 字符串 获取代码错误字符串。
innerError.message 字符串 获取概要错误消息。
innerError.target string 获取错误的源。 例如，如果存在无效文档，它为 documents 或 document id。

示例

成功响应示例

以下 JSON 对象是成功响应的示例。

状态代码：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
  }
}

错误响应示例

以下 JSON 对象是错误响应的示例。 其他错误代码的架构相同。

状态代码：500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

后续步骤

遵循快速入门，详细了解如何使用文档翻译和客户端库。

文档翻译入门