Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Возвращает количество задач для указанного задания.
Количество задач предоставляет количество задач по активному, запущенным или завершенным состоянию задачи, а также количество успешных или неудачных задач. Задачи в состоянии подготовки считаются запущенными. Обратите внимание, что возвращаемые числа не всегда могут быть актуальными. Если требуется точное количество задач, используйте запрос списка.

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
jobId	path	True	string	Идентификатор задания.
api-version	query	True	string	Версия API клиента.
timeout	query		integer int32	Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 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	Ответ, содержащий число задач для указанного задания. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Ошибка пакетной службы.

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

azure_auth

Microsoft Entra поток кода проверки подлинности OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

Job get task counts

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/taskcounts?api-version=2023-11-01.18.0

Sample Response

Status code:

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.
ErrorMessage	Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
TaskCounts	Задача учитывается для задания.
TaskCountsResult	Task и TaskSlot подсчитывают для задания.
TaskSlotCounts	TaskSlot подсчитывает значение для задания.

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

TaskCounts

Задача учитывается для задания.

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

TaskCountsResult

Task и TaskSlot подсчитывают для задания.

Имя	Тип	Описание
taskCounts	TaskCounts	Количество задач на состояние.
taskSlotCounts	TaskSlotCounts	Количество объектов TaskSlots, необходимых для задач на состояние.

TaskSlotCounts

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

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