Reservations Details - List

Odwołanie

Usługa:: Consumption

Wersja interfejsu API:: 2024-08-01

Wyświetla szczegóły rezerwacji dla podanego zakresu dat. 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. Jeśli rozmiar danych jest zbyt duży, klienci mogą również uzyskać 504, ponieważ limit czasu interfejsu API upłynął limit czasu przygotowywania danych. W takich przypadkach wywołanie interfejsu API powinno być wykonywane z mniejszymi zakresami dat lub wywołanie interfejsu API generowania raportu szczegółów rezerwacji powinno zostać wykonane, ponieważ jest asynchroniczne i nie zostanie przekroczone limity czasu rozmiaru odpowiedzi.

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

Z parametrami opcjonalnymi:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?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 szczegółów 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.
$filter	query		string	Filtruj szczegóły rezerwacji według zakresu dat. 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	ReservationDetailsListResult	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

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Przykładowe żądanie

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=2024-08-01

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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=2024-08-01

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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=2024-08-01

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  ]
}

Definicje

Nazwa	Opis
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.
ReservationDetail	zasób szczegółów rezerwacji.
ReservationDetailsListResult	Wynik wyświetlania szczegółów rezerwacji.

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.

ReservationDetail

Objekt

zasób szczegółów 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.instanceFlexibilityGroup	string	Grupa elastyczności wystąpienia.
properties.instanceFlexibilityRatio	string	Współczynnik elastyczności wystąpienia.
properties.instanceId	string	Ten identyfikator jest nazwą zasobu lub w pełni kwalifikowanym identyfikatorem zasobu.
properties.kind	string	Rodzaj rezerwacji.
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 dla dnia. 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)	Data wystąpienia zużycia.
properties.usedHours	number (decimal)	Jest to łączna liczba godzin używanych przez wystąpienie.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

ReservationDetailsListResult

Objekt

Wynik wyświetlania szczegółów rezerwacji.

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
value	ReservationDetail[]	Lista szczegółów rezerwacji.

Udostępnij za pośrednictwem

Reservations Details - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ReservationDetailsByBillingAccountId

Przykładowe żądanie

Przykładowa odpowiedź

ReservationDetailsByBillingProfileId

Przykładowe żądanie

Przykładowa odpowiedź

ReservationDetailsByBillingProfileIdReservationId

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult

Dodatkowe zasoby