Job - Get Task Counts

서비스:

Batch Service

API 버전:

2023-11-01.18.0

지정된 작업에 대한 작업 수를 가져옵니다.
작업 수는 활성, 실행 또는 완료된 작업 상태별 작업 수와 성공 또는 실패한 작업 수를 제공합니다. 준비 상태의 작업은 실행 중으로 계산됩니다. 반환된 숫자가 항상 최신이 아닐 수 있습니다. 정확한 작업 수가 필요한 경우 목록 쿼리를 사용합니다.

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

선택적 매개 변수:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
batchUrl	path	True	string	모든 Azure Batch 서비스 요청에 대한 기본 URL입니다.
jobId	path	True	string	작업의 ID입니다.
api-version	query	True	string	클라이언트 API 버전.
timeout	query		integer int32	서버가 요청을 처리하는 데 소요할 수 있는 최대 시간(초)입니다. 기본값은 30초입니다.

요청 헤더

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

Name	필수	형식	Description
client-request-id		string uuid	9C4D50EE-2D56-4CD3-8152-34347DC9F2B0과 같은 장식이 없는 GUID 형식의 호출자 생성 요청 ID입니다.
return-client-request-id		boolean	서버가 응답에서 client-request-id를 반환해야 하는지 여부입니다.
ocp-date		string date-time-rfc1123	요청이 실행된 시간입니다. 클라이언트 라이브러리는 일반적으로 이를 현재 시스템 클록 시간으로 설정합니다. REST API를 직접 호출하는 경우 명시적으로 설정합니다.

응답

Name	형식	Description
200 OK	TaskCountsResult	지정된 작업에 대한 작업 개수가 포함된 응답입니다. 헤더 client-request-id: string request-id: string
Other Status Codes	BatchError	Batch 서비스의 오류입니다.

보안

azure_auth

OAuth 2.0 인증 코드 흐름 Microsoft Entra

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

Authorization

형식: apiKey
In(다음 안에): header

예제

Job get task counts

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

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

정의

Name	Description
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
ErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
TaskCounts	작업에 대한 작업 개수입니다.
TaskCountsResult	Task 및 TaskSlot은 작업에 대한 개수입니다.
TaskSlotCounts	TaskSlot은 작업에 대한 개수입니다.

BatchError

Azure Batch 서비스에서 받은 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
message	ErrorMessage	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
values	BatchErrorDetail[]	오류에 대한 추가 세부 정보가 포함된 키-값 쌍의 컬렉션입니다.

BatchErrorDetail

Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.

Name	형식	Description
key	string	Value 속성의 의미를 지정하는 식별자입니다.
value	string	오류 응답에 포함된 추가 정보입니다.

ErrorMessage

Azure Batch 오류 응답에서 받은 오류 메시지입니다.

Name	형식	Description
lang	string	오류 메시지의 언어 코드
value	string	메시지의 텍스트입니다.

TaskCounts

작업에 대한 작업 개수입니다.

Name	형식	Description
active	integer	활성 상태의 작업 수입니다.
completed	integer	완료된 상태의 작업 수입니다.
failed	integer	실패한 작업 수입니다. 실행Info 속성에 있는 결과가 'failure'인 경우 태스크가 실패합니다.
running	integer	실행 중 또는 준비 상태의 작업 수입니다.
succeeded	integer	성공한 작업 수입니다. 실행Info 속성에 있는 결과가 'success'이면 작업이 성공합니다.

TaskCountsResult

Task 및 TaskSlot은 작업에 대한 개수입니다.

Name	형식	Description
taskCounts	TaskCounts	상태당 작업 수입니다.
taskSlotCounts	TaskSlotCounts	상태당 작업에 필요한 TaskSlot의 수입니다.

TaskSlotCounts

TaskSlot은 작업에 대한 개수입니다.

Name	형식	Description
active	integer	활성 작업에 대한 TaskSlot의 수입니다.
completed	integer	완료된 작업에 대한 TaskSlot의 수입니다.
failed	integer	실패한 작업에 대한 TaskSlot의 수입니다.
running	integer	작업을 실행하기 위한 TaskSlot의 수입니다.
succeeded	integer	성공한 작업에 대한 TaskSlot의 수입니다.