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

Job - Get Task Counts

服务:

Batch Service

API 版本:

2024-07-01.20.0

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

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2024-07-01.20.0

具有可选参数:

GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2024-07-01.20.0

URI 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有 Azure Batch 服务请求的基本 URL。
jobId	path	True	string	作业的 ID。
api-version	query	True	string	客户端 API 版本。
timeout	query		integer (int32)	服务器处理请求的最长时间（以秒为单位）。 默认值为 30 秒。 如果该值大于 30，则改用默认值。

请求头

Media Types: "application/json; odata=minimalmetadata"

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

响应

名称	类型	说明
200 OK	TaskCountsResult	包含指定作业的任务计数的响应。 标头 client-request-id: string request-id: string
Other Status Codes	BatchError	Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Job get task counts

示例请求

HTTP

GET account.region.batch.azure.com/jobs/jobId/taskcounts?api-version=2024-07-01.20.0

示例响应

状态代码:

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 错误响应中包含的附加信息项。
ErrorMessage	Azure Batch 错误响应中收到的错误消息。
TaskCounts	作业的任务计数。
TaskCountsResult	作业的任务和 TaskSlot 计数。
TaskSlotCounts	作业的 TaskSlot 计数。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

ErrorMessage

Object

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

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

TaskCounts

Object

作业的任务计数。

名称	类型	说明
active	integer (int32)	处于活动状态的任务数。
completed	integer (int32)	处于已完成状态的任务数。
failed	integer (int32)	失败的任务数。 如果任务的结果（在 executionInfo 属性中找到）为“failure”，则任务将失败。
running	integer (int32)	正在运行或准备状态的任务数。
succeeded	integer (int32)	成功的任务数。 如果任务的结果（在 executionInfo 属性中找到）为“success”，则任务会成功。

TaskCountsResult

Object

作业的任务和 TaskSlot 计数。

名称	类型	说明
taskCounts	TaskCounts	每个状态的任务数。
taskSlotCounts	TaskSlotCounts	每个状态的任务所需的 TaskSlot 数。

TaskSlotCounts

Object

作业的 TaskSlot 计数。

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