Přehled rozhraní API služby Azure Enterprise Reporting

  • Článek

Poznámka:

Všechna rozhraní API pro podnikové vytváření sestav Azure se vyřadí z důchodu. Co nejdříve byste měli migrovat na rozhraní API služby Microsoft Cost Management.

Rozhraní API pro vytváření sestav Azure enterprise umožňují zákazníkům Enterprise Azure programově načíst data o spotřebě a fakturaci do upřednostňovaných nástrojů pro analýzu dat. Podnikoví zákazníci podepsali smlouva Enterprise (EA) s Azure, aby vyjednali zálohu na Azure (dříve označovanou jako peněžní závazek) a získali přístup k vlastním cenovým cenovým prostředkům Azure.

Všechny parametry data a času požadované pro rozhraní API musí být reprezentované jako kombinované hodnoty koordinovaného světového času (UTC). Hodnoty vrácené rozhraními API se zobrazují ve formátu UTC.

Povolení přístupu k datům v rozhraní API

  • Vygenerování nebo načtení klíče rozhraní API – Další informace najdete v tématu Generování klíčů rozhraní API.
  • Předání klíčů do rozhraní API – klíč rozhraní API je potřeba předat při každém volání kvůli ověřování a autorizaci. Následující vlastnost musí být hlavičkami HTTP.
Klíč v hlavičce požadavku Hodnota
Autorizace Zadejte hodnotu v tomto formátu: bearer {KLÍČ_API}.
Příklad: bearer eyr....09

Rozhraní API na základě spotřeby

Koncový bod Swaggeru je k dispozici pro následující rozhraní API. Měly by umožnit snadnou introspekci rozhraní API a schopnost generovat sady SDK (Client Software Development Kit) pomocí AutoRest nebo Swagger CodeGen. Prostřednictvím tohoto rozhraní API jsou dostupná data od 1. května 2014.

  • Zůstatek a souhrn – Rozhraní API pro zůstatek a souhrn nabízí měsíční souhrn informací o zůstatcích, nových nákupech, poplatcích za služby Azure Marketplace, úpravách a poplatcích za nadlimitní využití.

  • Podrobnosti využití:Rozhraní API Podrobnosti využití poskytuje denní rozpis spotřebovaných prostředků a odhadované poplatky za určitou smlouvu. Výsledek obsahuje také informace o instancích, měřičích a odděleních. Dotazování rozhraní API podle fakturačního období nebo podle zadaného počátečního a koncového data

  • Poplatky za obchod Marketplace – Rozhraní API poplatku za obchod Marketplace vrátí rozpis poplatků za marketplace založený na využití podle dne pro zadané fakturační období nebo počáteční a koncové datum (jednorázové poplatky nejsou zahrnuté).

  • Ceník:Rozhraní API Ceník poskytuje platnou sazbu každého měřiče pro danou smlouvu a fakturační období.

  • Podrobnosti o rezervované instanci:Rozhraní API Podrobnosti o rezervované instanci vrací informace o využití nákupů rezervovaných instancí. Rozhraní API Podrobnosti o rezervované instanci uvádí provedené fakturační transakce.

Aktuálnost dat

Značky Etag se vrátí v odpovědi všech výše uvedených rozhraní API. Změna značky Etag označuje, že se data aktualizovala. V následných voláních stejného rozhraní API s využitím stejných parametrů předejte v hlavičce požadavku HTTP získanou značku ETag s klíčem „If-None-Match“. Stavový kód odpovědi je NotModified v případě, že se data dál neaktualizuje a nevrátí se žádná data. Rozhraní API vrátí úplnou datovou sadu pro požadované období, kdykoli dojde ke změně značky etag.

Pomocná rozhraní API

Seznam fakturačních období:Rozhraní API Fakturační období vrací seznam fakturačních období, která obsahují data o spotřebě pro danou smlouvu, a to v obráceném chronologickém pořadí. Každé období obsahuje vlastnost ukazující na trasu rozhraní API pro čtyři sady dat: BalanceSummary, UsageDetails, MarketplaceCharges a PriceSheet.

Kódy odpovědí rozhraní API

Stavový kód odpovědi Message Popis
200 OK Bez chyby
400 Nesprávná žádost Neplatné parametry – rozsahy dat, čísla smluv EA atd.
401 Neautorizováno Klíč rozhraní API se nedá najít, je neplatný, vypršela jeho platnost atd.
404 Neaktivní Nenašel se koncový bod sestavy.
429 TooManyRequests Požadavek se omezil. Po uplynutí časového limitu zadaného v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after zkuste operaci zopakovat.
500 Chyba serveru Neočekávaná chyba při zpracování žádosti
503 ServiceUnavailable Služba je dočasně nedostupná. Po uplynutí časového limitu zadaného v hlavičce Retry-After zkuste operaci zopakovat.