Udostępnij za pośrednictwem

Reservations Summaries - List

  • Odwołanie
Usługa:
Consumption
Wersja interfejsu API:
2024-08-01

Wyświetla podsumowanie rezerwacji dla zdefiniowanego zakresu dziennego lub miesięcznego. Uwaga: usługa ARM ma limit rozmiaru ładunku o rozmiarze 12 MB, więc obecnie osoby wywołujące otrzymują 400, gdy rozmiar odpowiedzi przekracza limit usługi ARM. W takich przypadkach wywołanie interfejsu API powinno być wykonywane z mniejszymi zakresami dat.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01
Z parametrami opcjonalnymi: 
GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}&api-version=2024-08-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceScope
 path True

string

Zakres skojarzony z operacjami podsumowania rezerwacji. Obejmuje to ciąg "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" dla zakresu BillingAccount (starsza wersja) oraz "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" dla zakresu BillingProfile (nowoczesne).
api-version
 query True

string

Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2023-03-01.
grain
 query True

datagrain

Może być codziennie lub co miesiąc
$filter
 query

string

Wymagane tylko dla ziarna dziennego. Właściwości/Data użycia dla daty rozpoczęcia i daty zakończenia. Filtr obsługuje wartości "le" i "ge". Nie dotyczy podczas wykonywania zapytań przy użyciu profilu rozliczeniowego
endDate
 query

string

Data zakończenia. Dotyczy tylko wykonywania zapytań przy użyciu profilu rozliczeniowego
reservationId
 query

string

Identyfikator GUID identyfikatora rezerwacji. Ważne tylko wtedy, gdy podano również wartość reservationOrderId. Filtrowanie do określonej rezerwacji
reservationOrderId
 query

string

Identyfikator GUID identyfikatora zamówienia rezerwacji. Wymagane, jeśli podano identyfikator rezerwacji. Filtrowanie do określonego zamówienia rezerwacji
startDate
 query

string

Data rozpoczęcia. Dotyczy tylko wykonywania zapytań przy użyciu profilu rozliczeniowego

Odpowiedzi

Nazwa Typ Opis
200 OK

ReservationSummariesListResult

OK. Żądanie zakończyło się pomyślnie.
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ReservationSummariesDailyWithBillingAccountId
ReservationSummariesDailyWithBillingProfileId
ReservationSummariesMonthlyWithBillingAccountId
ReservationSummariesMonthlyWithBillingProfileId
ReservationSummariesMonthlyWithBillingProfileIdReservationId

ReservationSummariesDailyWithBillingAccountId

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesDailyWithBillingProfileId

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?grain=daily&startDate=2017-10-01&endDate=2017-11-20&api-version=2024-08-01

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithBillingAccountId

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileId

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileIdReservationId

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc&api-version=2024-08-01

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

Definicje

Nazwa Opis
datagrain

Może być codziennie lub co miesiąc
ErrorDetails

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".

  • 504 Limit czasu bramy — upłynął limit czasu usługi podczas przetwarzania żądania. Jeśli to możliwe, zmniejsz zakres dat w żądaniu.
ReservationSummariesListResult

Wynik wyświetlania podsumowań rezerwacji.
ReservationSummary

zasób podsumowania rezerwacji.

datagrain

Wyliczanie

Może być codziennie lub co miesiąc

Wartość Opis
daily

Dzienne ziarno danych
monthly

Miesięczne ziarno danych

ErrorDetails

Objekt

Szczegóły błędu.

Nazwa Typ Opis
code

string

Kod błędu.
message

string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Objekt

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".

  • 504 Limit czasu bramy — upłynął limit czasu usługi podczas przetwarzania żądania. Jeśli to możliwe, zmniejsz zakres dat w żądaniu.

Nazwa Typ Opis
error

ErrorDetails

Szczegóły błędu.

ReservationSummariesListResult

Objekt

Wynik wyświetlania podsumowań rezerwacji.

Nazwa Typ Opis
nextLink

string

Link (adres URL) do następnej strony wyników.
value

ReservationSummary[]

Lista podsumowań rezerwacji.

ReservationSummary

Objekt

zasób podsumowania rezerwacji.

Nazwa Typ Opis
etag

string

Element etag zasobu.
id

string

Pełny kwalifikowany identyfikator arm zdarzenia.
name

string

Identyfikator, który jednoznacznie identyfikuje zdarzenie.
properties.avgUtilizationPercentage

number (decimal)

Jest to średnie wykorzystanie dla całego zakresu czasu. (dzień lub miesiąc w zależności od ziarna)
properties.kind

string

Rodzaj rezerwacji.
properties.maxUtilizationPercentage

number (decimal)

Jest to maksymalne użycie godzinowe w czasie użycia (dzień lub miesiąc). Na przykład jeśli rekord użycia odpowiada 12/10/2017 i w tej godzinie 4 i 5, użycie było 100%, to pole zwróci 100% dla tego dnia.
properties.minUtilizationPercentage

number (decimal)

Jest to minimalne użycie godzinowe w czasie użycia (dzień lub miesiąc). Na przykład jeśli rekord użycia odpowiada 12/10/2017 i w tej godzinie 4 i 5, użycie było 10%, to pole zwróci 10% dla tego dnia
properties.purchasedQuantity

number (decimal)

Jest to zakupiona ilość dla identyfikatora reservationId.
properties.remainingQuantity

number (decimal)

Jest to pozostała ilość dla identyfikatora reservationId.
properties.reservationId

string

Identyfikator rezerwacji jest identyfikatorem rezerwacji w ramach zamówienia rezerwacji. Każda rezerwacja jest grupowaniem w celu zastosowania zakresu korzyści, a także określa liczbę wystąpień, do których można zastosować korzyść rezerwacji.
properties.reservationOrderId

string

Identyfikator zamówienia rezerwacji to identyfikator zakupu rezerwacji. Każdy identyfikator zamówienia rezerwacji reprezentuje jedną transakcję zakupu. Zamówienie rezerwacji zawiera rezerwacje. Zamówienie rezerwacji określa rozmiar maszyny wirtualnej i region rezerwacji.
properties.reservedHours

number (decimal)

Jest to łączna liczba godzin zarezerwowanych. Na przykład jeśli rezerwacja dla 1 wystąpienia została wykonana 13:00, będzie to 11 godzin dla tego dnia i 24 godziny od kolejnych dni
properties.skuName

string

Jest to nazwa jednostki SKU usługi ARM. Może służyć do łączenia z polem serviceType w dodatkowych informacjach w rekordach użycia.
properties.totalReservedQuantity

number (decimal)

Jest to łączna liczba wystąpień zarezerwowanych dla identyfikatora reservationId.
properties.usageDate

string (date-time)

Dane odpowiadające rekordowi wykorzystania. Jeśli ziarno danych jest miesięczne, będzie to pierwszy dzień miesiąca.
properties.usedHours

number (decimal)

Łączna liczba używanych godzin przez rezerwację
properties.usedQuantity

number (decimal)

Jest to używana ilość dla identyfikatora reservationId.
properties.utilizedPercentage

number (decimal)

Jest to wykorzystana wartość procentowa identyfikatora rezerwacji.
tags

object

Tagi zasobów.
type

string

Typ zasobu.