Omówienie interfejsów API raportowania dla przedsiębiorstw platformy Azure

  • Artykuł

Uwaga

1 maja 2024 r. interfejsy API raportowania dla przedsiębiorstw platformy Azure zostaną wycofane. Wszystkie pozostałe interfejsy API raportowania przedsiębiorstwa przestaną odpowiadać na żądania. Klienci muszą wcześniej przejść do korzystania z interfejsów API usługi Microsoft Cost Management. Aby dowiedzieć się więcej, zobacz Omówienie migracji z raportowania dla przedsiębiorstw na platformie Azure do interfejsów API usługi Microsoft Cost Management.

Interfejsy API raportowania dla przedsiębiorstw platformy Azure umożliwiają klientom platformy Azure przedsiębiorstwa programowe ściąganie danych użycia i rozliczeń do preferowanych narzędzi do analizy danych. Klienci korporacyjni podpisali Umowa Enterprise (EA) z platformą Azure, aby wynegocjować przedpłatę za platformę Azure (wcześniej nazywaną zobowiązaniem pieniężnym) i uzyskać dostęp do niestandardowych cen zasobów platformy Azure.

Wszystkie parametry daty i godziny wymagane dla interfejsów API muszą być reprezentowane jako wartości uniwersalnego czasu koordynowanego (UTC). Wartości zwracane przez interfejsy API są wyświetlane w formacie UTC.

Włączanie dostępu do danych dla interfejsu API

  • Generowanie lub pobieranie klucza interfejsu API — aby uzyskać więcej informacji, zobacz Generowanie klucza interfejsu API.
  • Przekazywanie kluczy w interfejsie API — klucz interfejsu API powinien zostać przekazany do każdego wywołania uwierzytelniania i autoryzacji. Następująca właściwość musi być nagłówkami HTTP.
Klucz nagłówka żądania Wartość
Autoryzacja Określ wartość w tym formacie: bearer {API_KEY}
Przykład: bearer eyr....09

Interfejsy API użycia

Punkt końcowy struktury Swagger jest dostępny tutaj dla następujących interfejsów API. Powinny one umożliwić łatwą introspekcję interfejsu API oraz możliwość generowania zestawów deweloperskich oprogramowania klienckiego (SDK) przy użyciu rozwiązania AutoRest lub Swagger CodeGen. Dane są dostępne za pośrednictwem tego interfejsu API od 1 maja 2014 r.

  • Saldo i podsumowanie — interfejs API salda i podsumowania oferuje miesięczne podsumowanie informacji na temat sald, nowych zakupów, opłat za usługę Azure Marketplace, korekt i opłat nadwyżkowych.

  • Szczegółowe zestawienie użycia — interfejs API szczegółowego zestawienia użycia oferuje dzienny podział ilości wykorzystanych zasobów i szacowane opłaty według rejestracji. Wynik zawiera również informacje na temat wystąpień, liczników i działów. Wykonaj zapytanie dotyczące interfejsu API według okresu rozliczeniowego lub określonej daty rozpoczęcia i zakończenia.

  • Opłata za sklep Marketplace — interfejs API opłat za sklep Marketplace zwraca opłaty za korzystanie z platformy handlowej według dnia dla określonego okresu rozliczeniowego lub dat rozpoczęcia i zakończenia (opłaty jednorazowe nie są uwzględniane).

  • Arkusz cen — interfejs API arkusza cen udostępnia odpowiednią stawkę za każdy miernik dla danej rejestracji i okresu rozliczeniowego.

  • Szczegóły wystąpienia zarezerwowanego — interfejs API użycia wystąpienia zarezerwowanego zwraca użycie zakupów wystąpienia zarezerwowanego. Interfejs API opłat za wystąpienia zarezerwowane pokazuje dokonane transakcje rozliczeniowe.

Aktualność danych

Tagi Etag są zwracane w odpowiedzi na wszystkie powyższe interfejsy API. Zmiana w elemecie Etag wskazuje, że dane zostały odświeżone. W kolejnych wywołaniach tego samego interfejsu API z użyciem tych samych parametrów przekaż przechwycony element ETag z kluczem „If-None-Match” w nagłówku żądania HTTP. Kod stanu odpowiedzi to NotModified , jeśli dane nie są odświeżane i żadne dane nie są zwracane. Interfejs API zwraca pełny zestaw danych dla wymaganego okresu, gdy wystąpi zmiana elementu etag.

Interfejsy API pomocnika

Wyświetlanie listy okresów rozliczeniowych — interfejs API okresów rozliczeniowych zwraca listę okresów rozliczeniowych, które mają dane dotyczące użycia dla określonej rejestracji w odwrotnej kolejności chronologicznej. Każdy okres zawiera właściwość wskazującą trasę interfejsu API dla czterech zestawów danych — BalanceSummary, UsageDetails, Marketplace Charges i Price Sheet.

Kody odpowiedzi interfejsu API

Kod stanu odpowiedzi Wiadomość opis
200 OK Brak błędów
400 Nieprawidłowe żądanie Nieprawidłowe parametry — zakresy dat, numery EA itd.
401 Brak autoryzacji Nie znaleziono klucza interfejsu API, jest on nieprawidłowy, wygasł itd.
404 Niedostępny Nie znaleziono punktu końcowego raportu
429 TooManyRequests Żądanie zostało ograniczone. Poczekaj przez czas określony w nagłówku x-ms-ratelimit-microsoft.consumption-retry-after i spróbuj ponownie.
500 Błąd serwera Nieoczekiwany błąd podczas przetwarzania żądania
503 ServiceUnavailable Usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku Retry-After i spróbuj ponownie.