Reservations Summaries - List By Reservation Order And Reservation
일별 또는 월별 곡물에 대한 예약 요약을 나열합니다. 참고: ARM의 페이로드 크기 제한은 12MB이므로 응답 크기가 ARM 제한을 초과하면 현재 호출자는 400을 받습니다. 이러한 경우 API 호출은 더 작은 날짜 범위로 이루어져야 합니다.
GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01
GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&$filter={$filter}&api-version=2024-08-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
reservation
|
path | True |
string |
예약 ID |
reservation
|
path | True |
string |
예약의 주문 ID |
api-version
|
query | True |
string |
클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 버전은 2023-03-01입니다. |
grain
|
query | True |
매일 또는 매월 사용할 수 있습니다. |
|
$filter
|
query |
string |
일별 곡물에만 필요합니다. 시작 날짜 및 종료 날짜에 대한 properties/UsageDate입니다. 필터는 'le'와 'ge'를 지원합니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
그래. 요청이 성공했습니다. |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
Reservation |
Reservation |
ReservationSummariesDailyWithReservationId
샘플 요청
GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2024-08-01
샘플 응답
{
"value": [
{
"id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
"name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
"type": "Microsoft.Consumption/reservationSummaries",
"tags": {
"env": "newcrp",
"dev": "tools"
},
"properties": {
"reservationOrderId": "00000000-0000-0000-0000-000000000000",
"reservationId": "00000000-0000-0000-0000-000000000000",
"skuName": "Standard_D8s_v3",
"kind": "Reservation",
"reservedHours": 0,
"usageDate": "2017-10-01T00:00:00Z",
"usedHours": 0,
"minUtilizationPercentage": 0,
"avgUtilizationPercentage": 0,
"maxUtilizationPercentage": 0,
"purchasedQuantity": 0,
"remainingQuantity": 0,
"totalReservedQuantity": 155,
"usedQuantity": 0,
"utilizedPercentage": 0
}
}
]
}
ReservationSummariesMonthlyWithReservationId
샘플 요청
GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01
샘플 응답
{
"value": [
{
"id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
"name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
"type": "Microsoft.Consumption/reservationSummaries",
"tags": {
"env": "newcrp",
"dev": "tools"
},
"properties": {
"reservationOrderId": "00000000-0000-0000-0000-000000000000",
"reservationId": "00000000-0000-0000-0000-000000000000",
"skuName": "Standard_D8s_v3",
"kind": "Reservation",
"reservedHours": 0,
"usageDate": "2017-10-01T00:00:00Z",
"usedHours": 0,
"minUtilizationPercentage": 0,
"avgUtilizationPercentage": 0,
"maxUtilizationPercentage": 0,
"purchasedQuantity": 0,
"remainingQuantity": 0,
"totalReservedQuantity": 155,
"usedQuantity": 0,
"utilizedPercentage": 0
}
}
]
}
정의
Name | Description |
---|---|
datagrain |
매일 또는 매월 사용할 수 있습니다. |
Error |
오류의 세부 정보입니다. |
Error |
오류 응답은 서비스에서 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다. 일부 오류 응답:
|
Reservation |
예약 요약을 나열한 결과입니다. |
Reservation |
예약 요약 리소스입니다. |
datagrain
매일 또는 매월 사용할 수 있습니다.
값 | Description |
---|---|
daily |
일일 데이터 조직 |
monthly |
월별 데이터 곡물 |
ErrorDetails
오류의 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드입니다. |
message |
string |
작업이 실패한 이유를 나타내는 오류 메시지입니다. |
ErrorResponse
오류 응답은 서비스에서 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.
일부 오류 응답:
429 TooManyRequests - 요청이 제한됩니다. "x-ms-ratelimit-microsoft.consumption-retry-after" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.
503 ServiceUnavailable - 서비스를 일시적으로 사용할 수 없습니다. "Retry-After" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.
504 게이트웨이 시간 제한 - 요청을 처리하는 동안 서비스가 시간 초과되었습니다. 가능한 경우 요청의 날짜 범위를 줄입니다.
Name | 형식 | Description |
---|---|---|
error |
오류의 세부 정보입니다. |
ReservationSummariesListResult
예약 요약을 나열한 결과입니다.
Name | 형식 | Description |
---|---|---|
nextLink |
string |
결과의 다음 페이지에 대한 링크(URL)입니다. |
value |
예약 요약 목록입니다. |
ReservationSummary
예약 요약 리소스입니다.
Name | 형식 | Description |
---|---|---|
etag |
string |
리소스의 etag입니다. |
id |
string |
이벤트의 정규화된 ARM ID입니다. |
name |
string |
이벤트를 고유하게 식별하는 ID입니다. |
properties.avgUtilizationPercentage |
number (decimal) |
전체 시간 범위의 평균 사용률입니다. (곡물에 따라 일 또는 월) |
properties.kind |
string |
예약 종류입니다. |
properties.maxUtilizationPercentage |
number (decimal) |
이는 사용 시간(일 또는 월)의 최대 시간 사용률입니다. 예를 들어 사용 레코드가 2017/12/10에 해당하고 4시간 및 5시간 동안 사용률이 100%경우 이 필드는 해당 날짜에 대해 100% 반환합니다. |
properties.minUtilizationPercentage |
number (decimal) |
이는 사용 시간(일 또는 월)의 최소 시간별 사용률입니다. 예를 들어 사용 레코드가 2017/12/10에 해당하고 4시간 및 5시간 동안 사용률이 10%경우 이 필드는 해당 날짜에 대해 10개의% 반환합니다. |
properties.purchasedQuantity |
number (decimal) |
reservationId에 대해 구매한 수량입니다. |
properties.remainingQuantity |
number (decimal) |
reservationId의 나머지 수량입니다. |
properties.reservationId |
string |
예약 ID는 예약 주문 내의 예약 식별자입니다. 각 예약은 혜택 범위를 적용하기 위한 그룹화이며 예약 혜택을 적용할 수 있는 인스턴스 수를 지정합니다. |
properties.reservationOrderId |
string |
예약 주문 ID는 예약 구매의 식별자입니다. 각 예약 주문 ID는 단일 구매 트랜잭션을 나타냅니다. 예약 주문에는 예약이 포함됩니다. 예약 순서는 예약에 대한 VM 크기 및 지역을 지정합니다. |
properties.reservedHours |
number (decimal) |
예약된 총 시간입니다. 예를 들어 1개 인스턴스에 대한 예약이 오후 1시에 이루어진 경우 해당 날짜의 경우 11시간, 이후 날짜로부터 24시간이 됩니다. |
properties.skuName |
string |
ARM Sku 이름입니다. 사용 레코드의 추가 정보에서 serviceType 필드와 조인하는 데 사용할 수 있습니다. |
properties.totalReservedQuantity |
number (decimal) |
reservationId에 예약된 인스턴스의 총 개수입니다. |
properties.usageDate |
string (date-time) |
사용률 레코드에 해당하는 데이터입니다. 데이터의 세분화가 매월이면 월의 첫째 날이 됩니다. |
properties.usedHours |
number (decimal) |
예약별 총 사용 시간 |
properties.usedQuantity |
number (decimal) |
reservationId에 사용되는 수량입니다. |
properties.utilizedPercentage |
number (decimal) |
예약 ID에 대한 사용률입니다. |
tags |
object |
리소스 태그. |
type |
string |
리소스 종류입니다. |