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

获取翻译状态

  • 项目

参考
服务：Azure AI 文档翻译
API 版本：v1.1

获取翻译状态方法可返回文档翻译请求的状态。 该状态包括总体请求状态以及请求中正在进行翻译的文档的状态。

请求 URL

将 GET 请求发送到：

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

了解如何查找自定义域名。

重要

  • 向文档翻译服务发出的所有 API 请求都需要一个自定义域终结点。
  • 不能使用 Azure 门户资源的“密钥和终结点”页上的终结点或者全局翻译器终结点 (api.cognitive.microsofttranslator.com) 来向文档翻译发出 HTTP 请求。

请求参数

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

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

请求标头

请求标头为：

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

响应状态代码

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

状态代码 说明
200 没问题。 成功请求并返回批处理翻译操作的状态。 HeadersRetry-After: integerETag: string
401 未授权。 检查凭据。
404 找不到资源。
500 内部服务器错误。
其他状态代码 • 请求过多
• 服务器临时不可用

获取翻译状态响应

成功获取翻译状态响应

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

名称 Type 说明
id 字符串 操作的 ID。
createdDateTimeUtc 字符串 操作创建的日期时间。
lastActionDateTimeUtc string 更新操作状态的日期时间。
状态 字符串 作业或文档可能所处状态的列表：
• 已取消
•取消
•失败
• 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 对象是成功响应的示例。

{
  "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 对象是错误响应的示例。 其他错误代码的架构相同。

状态代码：401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

后续步骤

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

文档翻译入门