Account - List Pool Node Counts

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

GET {batchUrl}/nodecounts?api-version=2023-11-01.18.0
GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
batchUrl
path True

string

모든 Azure Batch 서비스 요청에 대한 기본 URL입니다.

api-version
query True

string

클라이언트 API 버전.

$filter
query

string

OData $filter 절입니다. 이 필터를 생성하는 방법에 대한 자세한 내용은 를 참조하세요 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.

maxresults
query

integer

int32

응답에서 반환할 최대 항목 수입니다.

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

PoolNodeCountsListResult

응답에는 풀별로 그룹화된 각 컴퓨팅 노드 상태의 컴퓨팅 노드 수가 포함됩니다.

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Batch 서비스의 오류입니다.

보안

azure_auth

OAuth 2.0 인증 코드 흐름 Microsoft Entra

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

Authorization

Type: apiKey
In: header

예제

NodeCountsPayload

Sample Request

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


Sample Response

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 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,
        "total": 0
      },
      "lowPriority": {
        "creating": 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,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 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,
        "total": 4
      },
      "lowPriority": {
        "creating": 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,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 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,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 11
      }
    }
  ]
}

정의

Name Description
BatchError

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

BatchErrorDetail

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

ErrorMessage

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

NodeCounts

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

PoolNodeCounts

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

PoolNodeCountsListResult

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

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

메시지의 텍스트입니다.

NodeCounts

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

Name 형식 Description
creating

integer

만들기 상태의 컴퓨팅 노드 수입니다.

idle

integer

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

leavingPool

integer

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

offline

integer

오프라인 상태의 컴퓨팅 노드 수입니다.

preempted

integer

선점된 상태의 컴퓨팅 노드 수입니다.

rebooting

integer

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

reimaging

integer

이미지 상태의 컴퓨팅 노드 수입니다.

running

integer

실행 중인 상태의 컴퓨팅 노드 수입니다.

startTaskFailed

integer

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

starting

integer

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

total

integer

컴퓨팅 노드의 총 수입니다.

unknown

integer

알 수 없는 상태의 컴퓨팅 노드 수입니다.

unusable

integer

사용할 수 없는 상태의 컴퓨팅 노드 수입니다.

waitingForStartTask

integer

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

PoolNodeCounts

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

Name 형식 Description
dedicated

NodeCounts

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

lowPriority

NodeCounts

각 상태의 스폿/낮은 우선 순위 컴퓨팅 노드 수입니다.

poolId

string

풀의 ID입니다.

PoolNodeCountsListResult

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

Name 형식 Description
odata.nextLink

string

다음 결과 집합을 가져올 URL입니다.

value

PoolNodeCounts[]

풀별 컴퓨팅 노드 개수 목록입니다.