Job - Get Task Counts

Ссылка

Service:: Batch Service

API Version:: 2022-01-01.15.0

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

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2022-01-01.15.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2022-01-01.15.0

Параметры URI

Name	In	Required	Type	Description
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"

Name	Type	Description
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 напрямую.

Ответы

Name	Type	Description
200 OK	TaskCountsResult	Ответ, содержащий счетчики задач для указанного задания. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

Name

Type

Description

200 OK

TaskCountsResult

Ответ, содержащий счетчики задач для указанного задания.

Headers

client-request-id: string
request-id: string

Other Status Codes

BatchError

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

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

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
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=2022-01-01.15.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	Количество задач и taskSlot для задания.
TaskSlotCounts	Объект TaskSlot подсчитывает количество заданий.

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

Name	Type	Description
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.

TaskCounts

Количество задач для задания.

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

TaskCountsResult

Количество задач и taskSlot для задания.

Name	Type	Description
taskCounts	TaskCounts	Количество задач в каждом состоянии.
taskSlotCounts	TaskSlotCounts	Количество объектов TaskSlots, необходимых задачам на каждое состояние.

TaskSlotCounts

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

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