获取所有翻译作业的状态

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

• 使用 get translations status 方法请求用户提交的所有翻译作业的列表和状态（与资源关联）。

• $top、$skip 和 $maxpagesize 查询参数可用于指定要返回的结果数以及集合的偏移量。

  • $top 指示要在所有页面中返回的记录总数。
  • $skip 指示根据指定的排序方法从批列表中跳过的记录数。 默认情况下，记录按开始时间以降序方式排序。
  • $maxpagesize 是单个页面中返回的最大项数。
  • 如果通过 $top 请求更多项（或者未指定 $top，但有更多项要返回），@nextLink 会包含指向下一页的链接。
  • 服务器遵循客户端指定的值。 但是，客户端必须准备好处理包含不同页面大小的响应或包含延续标记的响应。
  • 当同时包含这两$top个服务器时$skip，服务器将首先应用，然后在$skip集合上应用$top。

• $orderBy 查询参数可用于对返回的列表排序（示例：$orderBy=createdDateTimeUtc asc 或 $orderBy=createdDateTimeUtc desc）。
  • 默认排序为按 createdDateTimeUtc 以降序方式排序。 一些查询参数可用于筛选返回的列表（示例：status=Succeeded,Cancelled 返回成功的和取消的操作）。
  • createdDateTimeUtcStart可以组合和createdDateTimeUtcEnd查询参数，也可以单独用于指定一系列日期/时间以筛选返回的列表。
  • 支持的筛选查询参数为 status、id、createdDateTimeUtcStart 和 createdDateTimeUtcEnd。

请求网址

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

请求参数

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

请求标头

请求标头为：

响应状态代码

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

获取翻译状态响应

成功获取翻译状态响应

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

错误响应

示例

成功响应示例

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

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://chinanorth2.cognitiveservices.azure.cn/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?`$top`=5&`$skip`=15"
}

错误响应示例

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

状态代码：500

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

后续步骤

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