Pools - List Pool Node Counts

서비스:: Batch Service

API 버전:: 2025-06-01

풀별로 그룹화된 각 상태의 컴퓨팅 노드 수를 가져옵니다. 반환된 숫자가 항상 최신이 아닐 수도 있습니다. 정확한 노드 수가 필요한 경우 목록 쿼리를 사용합니다.

GET {endpoint}/nodecounts?api-version=2025-06-01

선택적 매개 변수:

GET {endpoint}/nodecounts?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string (uri)	Batch 계정 엔드포인트(예: https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.
$filter	query		string	OData $filter 절입니다. 이 필터 구성에 대한 자세한 내용은 .를 참조하세요 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	응답에 반환할 최대 항목 수입니다. 최대 1000건의 신청서를 제출할 수 있습니다.
timeOut	query		integer (int32)	서버에서 요청을 처리하는 데 소요할 수 있는 최대 시간(초)입니다. 기본값은 30초입니다. 만약 값이 30보다 크면 기본값이 대신 사용됩니다."라고 말했습니다.

요청 헤더

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

응답

Name	형식	Description
200 OK	BatchPoolNodeCountsListResult	요청이 성공했습니다. 헤더 ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	예기치 않은 오류 응답입니다.

Name

형식

Description

200 OK

BatchPoolNodeCountsListResult

요청이 성공했습니다.

헤더

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

범위

Name	Description
https://batch.core.windows.net//.default

예제

NodeCountsPayload

샘플 요청

HTTP

GET {endpoint}/nodecounts?api-version=2025-06-01

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 11
      }
    }
  ]
}

정의

Name	Description
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
BatchErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
BatchNodeCounts	각 컴퓨팅 노드 상태의 컴퓨팅 노드 수입니다.
BatchPoolNodeCounts	풀에 대한 각 상태의 컴퓨팅 노드 수입니다.
BatchPoolNodeCountsListResult	계정에 컴퓨팅 노드 수를 나열한 결과입니다.

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

BatchErrorMessage

Object

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

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

BatchNodeCounts

Object

각 컴퓨팅 노드 상태의 컴퓨팅 노드 수입니다.

Name	형식	Description
creating	integer (int32)	생성 상태의 컴퓨트 노드 수.
deallocated	integer (int32)	할당 해제된 상태의 컴퓨트 노드 수.
deallocating	integer (int32)	분리 상태에 있는 컴퓨트 노드의 수.
idle	integer (int32)	유휴 상태의 컴퓨트 노드 수.
leavingPool	integer (int32)	leavevingPool 상태에 있는 컴퓨트 노드의 수.
offline	integer (int32)	오프라인 상태의 컴퓨트 노드 수.
preempted	integer (int32)	선점 상태에 있는 컴퓨트 노드의 수.
rebooting	integer (int32)	재부팅 상태의 컴퓨트 노드 수.
reimaging	integer (int32)	재이미징 상태의 컴퓨트 노드 수.
running	integer (int32)	실행 중인 컴퓨트 노드의 수.
startTaskFailed	integer (int32)	startTaskFailed 상태에 있는 컴퓨트 노드의 수.
starting	integer (int32)	시작 상태의 컴퓨트 노드 수.
total	integer (int32)	총 컴퓨트 노드 수.
unknown	integer (int32)	미지의 상태에 있는 컴퓨트 노드의 수.
unusable	integer (int32)	사용할 수 없는 상태의 컴퓨트 노드 수.
upgradingOS	integer (int32)	upgradingOS 상태에 있는 컴퓨트 노드 수.
waitingForStartTask	integer (int32)	waitingForStartTask 상태에 있는 컴퓨트 노드의 수.

BatchPoolNodeCounts

Object

풀에 대한 각 상태의 컴퓨팅 노드 수입니다.

Name	형식	Description
dedicated	BatchNodeCounts	각 상태에 있는 전용 컴퓨트 노드의 수.
lowPriority	BatchNodeCounts	각 상태별 스팟/저우선순위 컴퓨트 노드의 수.
poolId	string	수영장 ID입니다.

BatchPoolNodeCountsListResult

Object

계정에 컴퓨팅 노드 수를 나열한 결과입니다.

Name	형식	Description
odata.nextLink	string (uri)	다음 결과 집합을 가져올 URL입니다.
value	BatchPoolNodeCounts[]	Pool별 컴퓨트 노드 수 목록입니다.

다음을 통해 공유

Pools - List Pool Node Counts

URI 매개 변수

요청 헤더

응답

보안

OAuth2Auth

범위

예제

NodeCountsPayload

샘플 요청

샘플 응답

정의

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeCounts

BatchPoolNodeCounts

BatchPoolNodeCountsListResult