检索提交到资源的所有批处理翻译作业的列表,以及每个作业的状态和摘要信息。 响应支持分页和筛选,这对于审核作业历史记录或恢复作业 ID 非常有用。
HTTP 方法: GET API 版本: 2026-03-01
请求
GET {endpoint}/translator/document/batches?api-version=2026-03-01
| 标题 |
必需 |
Description |
Ocp-Apim-Subscription-Key |
是的 |
Azure门户中的翻译器资源密钥。 |
Ocp-Apim-Subscription-Region |
条件 |
如果使用区域资源,则为必需。 |
查询参数
| 参数 |
必需 |
Description |
api-version |
是的 |
API 的版本。 当前值: 2026-03-01. |
$top |
No |
要返回的最大记录数。 |
$skip |
No |
要跳过的记录数(用于分页)。 |
$orderBy |
No |
排序字段。 支持值: createdDateTimeUtc, lastActionDateTimeUtc。 |
statuses |
No |
按状态筛选。 支持的值:NotStarted、、、RunningSucceeded、FailedCancelled、。 CancellingValidationFailed |
createdDateTimeUtcStart |
No |
筛选为在此日期时间之后创建的作业(UTC,ISO 8601)。 |
createdDateTimeUtcEnd |
No |
筛选为在此日期/时间之前创建的作业(UTC,ISO 8601)。 |
示例请求
获取最新的作业
curl -X GET "{endpoint}/translator/document/batches?api-version=2026-03-01" \
-H "Ocp-Apim-Subscription-Key: {key}"
按状态筛选
curl -X GET "{endpoint}/translator/document/batches?api-version=2026-03-01&statuses=Succeeded&statuses=Cancelled" \
-H "Ocp-Apim-Subscription-Key: {key}"
响应
响应状态代码
| 状态代码 |
Description |
200 |
单击“确定”。 返回翻译作业及其状态的列表。 |
401 |
身份验证失败。 检查订阅密钥。 |
500 |
内部服务器错误。 |
响应正文
| 领域 |
类型 |
Description |
value |
数组 |
转换作业状态对象的数组。 |
value[].id |
字符串 |
作业编号。 使用此值调用 “获取翻译”状态。 |
value[].status |
字符串 |
总体作业状态。 |
value[].createdDateTimeUtc |
字符串 |
作业创建日期/时间(UTC)。 |
value[].lastActionDateTimeUtc |
字符串 |
上次状态更改日期/时间(UTC)。 |
value[].summary |
对象 |
按状态统计的文档计数摘要。 |
nextLink |
字符串 |
如果应用分页,则为下一页结果的 URL。 |
相关内容