Reservations Details - List

참조

Service:: Consumption

API Version:: 2023-05-01

제공된 날짜 범위에 대한 예약 세부 정보를 Lists. 참고: ARM의 페이로드 크기 제한은 12MB이므로 응답 크기가 ARM 제한을 초과하면 현재 호출자는 400을 받습니다. 데이터 크기가 너무 크면 API가 데이터 준비 시간 초과로 504를 받을 수도 있습니다. 이러한 경우 API 호출은 더 작은 날짜 범위로 수행되어야 하며, 비동기이며 응답 크기 제한으로 실행되지 않으므로 예약 세부 정보 보고서 API 생성을 호출해야 합니다.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?api-version=2023-05-01

With optional parameters:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}&api-version=2023-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceScope	path	True	string	예약 세부 정보 작업과 연결된 scope. 여기에는 BillingAccount scope(레거시)용 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' 및 BillingProfile scope(최신)에 대한 '/providers/Microsoft.Billing/billingAccountId}/{billingProfileId}'가 포함됩니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 버전은 2023-03-01입니다.
$filter	query		string	날짜 범위별로 예약 세부 정보를 필터링합니다. 시작 날짜 및 종료 날짜에 대한 properties/UsageDate입니다. 필터는 'le' 및 'ge'를 지원합니다. 청구 프로필로 쿼리할 때는 적용되지 않습니다.
endDate	query		string	종료 날짜입니다. 청구 프로필을 사용하여 쿼리할 때만 적용 가능
reservationId	query		string	예약 ID GUID입니다. reservationOrderId도 제공되는 경우에만 유효합니다. 특정 예약으로 필터링
reservationOrderId	query		string	예약 주문 ID GUID입니다. reservationId가 제공된 경우 필요합니다. 특정 예약 주문으로 필터링
startDate	query		string	시작 날짜입니다. 청구 프로필을 사용하여 쿼리할 때만 적용 가능

응답

Name	형식	Description
200 OK	ReservationDetailsListResult	OK. 요청이 성공했습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails?$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05&api-version=2023-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2017-11-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileId

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&api-version=2023-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileIdReservationId

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc&api-version=2023-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

정의

Name	Description
ErrorDetails	오류의 세부 정보입니다.
ErrorResponse	오류 응답은 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 이유는 오류 메시지에 제공됩니다. 일부 오류 응답: 429 TooManyRequests - 요청이 제한됩니다. "x-ms-ratelimit-microsoft.consumption-retry-after" 헤더에 지정된 시간을 기다린 후 다시 시도합니다. 503 ServiceUnavailable - 서비스를 일시적으로 사용할 수 없습니다. "Retry-After" 헤더에 지정된 시간 동안 기다린 후 다시 시도합니다.
ReservationDetail	예약 세부 정보 리소스.
ReservationDetailsListResult	예약 세부 정보를 나열한 결과입니다.

ErrorDetails

오류의 세부 정보입니다.

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

ErrorResponse

오류 응답은 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 이유는 오류 메시지에 제공됩니다.

일부 오류 응답:

429 TooManyRequests - 요청이 제한됩니다. "x-ms-ratelimit-microsoft.consumption-retry-after" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.
503 ServiceUnavailable - 서비스를 일시적으로 사용할 수 없습니다. "Retry-After" 헤더에 지정된 시간 동안 기다린 후 다시 시도합니다.

Name	형식	Description
error	ErrorDetails	오류의 세부 정보입니다.

ReservationDetail

예약 세부 정보 리소스.

Name	형식	Description
etag	string	리소스의 etag입니다.
id	string	이벤트의 정규화된 ARM ID입니다.
name	string	이벤트를 고유하게 식별하는 ID입니다.
properties.instanceFlexibilityGroup	string	instance 유연성 그룹입니다.
properties.instanceFlexibilityRatio	string	instance 유연성 비율입니다.
properties.instanceId	string	이 식별자는 리소스의 이름 또는 정규화된 리소스 ID입니다.
properties.kind	string	예약 종류입니다.
properties.reservationId	string	예약 ID는 예약 주문 내의 예약 식별자입니다. 각 예약은 혜택 scope 적용하기 위한 그룹화이며 예약 혜택을 적용할 수 있는 인스턴스 수를 지정합니다.
properties.reservationOrderId	string	예약 주문 ID는 예약 구매의 식별자입니다. 각 예약 주문 ID는 단일 구매 트랜잭션을 나타냅니다. 예약 주문에는 예약이 포함됩니다. 예약 순서는 예약에 대한 VM 크기 및 지역을 지정합니다.
properties.reservedHours	number	이 시간은 하루 동안 예약된 총 시간입니다. 예를 들어 오후 1시에 1 instance 예약한 경우 해당 날짜의 경우 11시간, 이후 날짜로부터 24시간이 됩니다.
properties.skuName	string	ARM Sku 이름입니다. 사용 레코드의 추가 정보에서 serviceType 필드와 조인하는 데 사용할 수 있습니다.
properties.totalReservedQuantity	number	reservationId에 예약된 인스턴스의 총 수입니다.
properties.usageDate	string	소비가 발생한 날짜입니다.
properties.usedHours	number	이는 instance 사용하는 총 시간입니다.
tags	object	리소스 태그.
type	string	리소스 종류.

ReservationDetailsListResult

예약 세부 정보를 나열한 결과입니다.

Name	형식	Description
nextLink	string	결과의 다음 페이지에 대한 링크(URL)입니다.
value	ReservationDetail[]	예약 세부 정보 목록입니다.

Share via

Reservations Details - List

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

ReservationDetailsByBillingAccountId

Sample Request

Sample Response

ReservationDetailsByBillingProfileId

Sample Request

Sample Response

ReservationDetailsByBillingProfileIdReservationId

Sample Request

Sample Response

정의

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult

추가 리소스