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)	Конечная точка учетной записи пакетной службы (например, 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	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

BatchTaskCountsResult

Запрос выполнен успешно.

Заголовки

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: 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.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchTaskCounts	Число задач для задания.
BatchTaskCountsResult	Задача и задачаSlot подсчитывается для задания.
BatchTaskSlotCounts	Объект TaskSlot подсчитывает задание.

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.

BatchTaskCounts

Объект

Число задач для задания.

Имя	Тип	Описание
active	integer (int32)	Количество задач в активном состоянии.
completed	integer (int32)	Количество заданий в завершённом состоянии.
failed	integer (int32)	Количество неудачных заданий. Задача проваливается, если её результат (в свойстве executionInfo) — «failure».
running	integer (int32)	Количество задач в состоянии запуска или подготовки.
succeeded	integer (int32)	Количество выполненных Заданий. Задача успешна, если её результат (в свойстве executionInfo) — «успех».

BatchTaskCountsResult

Объект

Задача и задачаSlot подсчитывается для задания.

Имя	Тип	Описание
taskCounts	BatchTaskCounts	Количество заданий в каждом штате.
taskSlotCounts	BatchTaskSlotCounts	Количество слотов задач, требуемых задачами в каждом штате.

BatchTaskSlotCounts

Объект

Объект TaskSlot подсчитывает задание.

Имя	Тип	Описание
active	integer (int32)	Количество слотов для активных задач.
completed	integer (int32)	Количество слотов задач для выполненных задач.
failed	integer (int32)	Количество слотов задач для неудачных задач.
running	integer (int32)	Количество слотов задач для выполнения задач.
succeeded	integer (int32)	Количество слотов задач для успешных задач.