Pool - List Usage Metrics

  • 참조
Service:
Batch Service
API Version:
2023-11-01.18.0

지정된 계정에 대해 개별 시간 간격에 걸쳐 풀로 집계된 사용 메트릭을 나열합니다.
poolId를 포함하여 $filter 절을 지정하지 않으면 반환된 집계 간격의 시간 범위에서 계정에 존재했던 모든 풀이 응답에 포함됩니다. startTime 또는 endTime을 포함하여 $filter 절을 지정하지 않으면 이러한 필터는 기본적으로 현재 사용 가능한 마지막 집계 간격의 시작 및 종료 시간으로 설정됩니다. 즉, 마지막 집계 간격만 반환됩니다.

GET {batchUrl}/poolusagemetrics?api-version=2023-11-01.18.0
With optional parameters: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$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#list-account-usage-metrics.
endtime
 query

string

date-time

메트릭을 포함할 최신 시간입니다. 이 시간은 현재 시간 2시간 이상 전에 있어야 합니다. 지정하지 않으면 이 기본값은 현재 사용 가능한 마지막 집계 간격의 종료 시간으로 설정됩니다.
maxresults
 query

integer

int32

응답에서 반환할 최대 항목 수입니다. 최대 1000 결과가 반환됩니다.
starttime
 query

string

date-time

메트릭을 포함할 가장 빠른 시간입니다. 이 시간은 현재 시간 이전의 2시간 반 이상이어야 합니다. 지정하지 않으면 이 기본값은 현재 사용 가능한 마지막 집계 간격의 시작 시간으로 설정됩니다.
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

PoolListUsageMetricsResult

풀 사용량 세부 정보 목록을 포함하는 응답입니다.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: 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

예제

Pool list usage metrics

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "startTime": "2013-04-01T00:00:00Z",
      "endTime": "2013-04-01T00:30:00Z",
      "poolId": "p1",
      "vmSize": "a1",
      "totalCoreHours": 39.384838
    },
    {
      "startTime": "2013-04-01T00:30:00Z",
      "endTime": "2013-04-01T01:00:00Z",
      "poolId": "p2",
      "vmSize": "a8",
      "totalCoreHours": 3039.384838
    }
  ]
}

정의

Name Description
BatchError

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

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

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

계정에 대한 사용 메트릭을 나열한 결과입니다.
PoolUsageMetrics

집계 간격에 걸쳐 풀에 대한 사용 메트릭입니다.

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

메시지의 텍스트입니다.

PoolListUsageMetricsResult

계정에 대한 사용 메트릭을 나열한 결과입니다.

Name 형식 Description
odata.nextLink

string

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

PoolUsageMetrics[]

풀 사용 메트릭 데이터입니다.

PoolUsageMetrics

집계 간격에 걸쳐 풀에 대한 사용 메트릭입니다.

Name 형식 Description
endTime

string

이 항목에서 다루는 집계 간격의 종료 시간입니다.
poolId

string

메트릭이 이 항목에서 집계되는 풀의 ID입니다.
startTime

string

이 항목에서 다루는 집계 간격의 시작 시간입니다.
totalCoreHours

number

이 집계 간격 동안 풀에 사용된 총 코어 시간입니다.
vmSize

string

풀의 가상 머신 크기입니다. 풀의 모든 VM 크기는 동일합니다.
풀에서 사용 가능한 가상 머신 크기에 대한 자세한 내용은 Azure Batch 풀(https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)에서 컴퓨팅 노드에 대한 VM 크기 선택을 참조하세요.