Jobs - Get Job Task Counts

服务:

Batch Service

API 版本:

2025-06-01

获得指定作业的任务计数。
任务计数提供了按任务状态（当前、运行中或已完成）的任务计数，以及成功或失败任务的计数。 处于准备状态的任务计为正在运行。 请注意，返回的数字可能并不总是最新的。 如果你需要精确的任务数量，可以用列表查询。

GET {endpoint}/jobs/{jobId}/taskcounts?api-version=2025-06-01

具有可选参数:

GET {endpoint}/jobs/{jobId}/taskcounts?api-version=2025-06-01&timeOut={timeOut}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	Batch 帐户终结点（例如：https://batchaccount.eastus2.batch.azure.com）。
jobId	path	True	string	工作身份证。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
timeOut	query		integer (int32)	服务器处理请求的最长时间（以秒为单位）。 默认为 30 秒。 如果值大于30，则使用默认值。”

请求头

名称	必需	类型	说明
client-request-id		string	调用方生成的请求标识，采用不带大括号的 GUID 形式，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id		boolean	服务器是否应在响应中返回 client-request-id。
ocp-date		string (date-time-rfc7231)	发出请求的时间。 客户端库通常将此设置为当前的系统时钟时间;如果直接调用 REST API，请显式设置它。

响应

名称	类型	说明
200 OK	BatchTaskCountsResult	请求已成功。 标头 ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	意外错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://batch.core.windows.net//.default

示例

Job get task counts

示例请求

HTTP

GET {endpoint}/jobs/jobId/taskcounts?api-version=2025-06-01

示例响应

状态代码:

200

{
  "taskCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  },
  "taskSlotCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  }
}

定义

名称	说明
BatchError	从 Azure Batch 服务收到的错误响应。
BatchErrorDetail	Azure Batch 错误响应中包含的附加信息项。
BatchErrorMessage	Azure Batch 错误响应中收到的错误消息。
BatchTaskCounts	作业的任务计数。
BatchTaskCountsResult	作业的任务和 TaskSlot 计数。
BatchTaskSlotCounts	作业的 TaskSlot 计数。

BatchError

对象

从 Azure Batch 服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
message	BatchErrorMessage	描述错误的消息，旨在适合在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

对象

Azure Batch 错误响应中包含的附加信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

BatchErrorMessage

对象

Azure Batch 错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码。
value	string	消息的文本。

BatchTaskCounts

对象

作业的任务计数。

名称	类型	说明
active	integer (int32)	处于活跃状态的任务数量。
completed	integer (int32)	完成状态下的任务数量。
failed	integer (int32)	失败的任务数量。 如果任务的结果（见执行信息属性）为“失败”，则该任务失败。
running	integer (int32)	运行或准备状态下的任务数量。
succeeded	integer (int32)	成功的任务数量。 如果任务的结果（见 executionInfo 属性）为“成功”，则该任务为成功。

BatchTaskCountsResult

对象

作业的任务和 TaskSlot 计数。

名称	类型	说明
taskCounts	BatchTaskCounts	每个州的任务数量。
taskSlotCounts	BatchTaskSlotCounts	每个州任务所需的任务槽数。

BatchTaskSlotCounts

对象

作业的 TaskSlot 计数。

名称	类型	说明
active	integer (int32)	用于活动任务的任务槽数量。
completed	integer (int32)	完成任务的任务槽数。
failed	integer (int32)	任务槽的数量用于失败任务。
running	integer (int32)	用于运行任务的任务槽数量。
succeeded	integer (int32)	成功任务的任务槽数。