Share via

Översikt över Azure Enterprise Reporting-API:er

  • Artikel

Kommentar

Alla Azure Enterprise Reporting-API:er har dragits tillbaka. Du bör migrera till Microsoft Cost Management-API:er så snart som möjligt.

Azure Enterprise Reporting-API:erna gör det möjligt för Enterprise Azure-kunder att programmatiskt hämta förbruknings- och faktureringsdata till önskade dataanalysverktyg. Företagskunder signerade en företagsavtal (EA) med Azure för att göra en förhandlad Azure-förskottsbetalning (kallades tidigare ekonomiskt åtagande) och få tillgång till anpassad prissättning för Azure-resurser.

Alla datum- och tidsparametrar som krävs för API:er måste anges som kombinerade UTC-värden (Coordinated Universal Time). Värden som returneras av API:er visas i UTC-format.

Aktivera dataåtkomst till API:et

  • Generera eller hämta API-nyckeln – Mer information finns i API-nyckelgenerering.
  • Skicka nycklar i API:et – API-nyckeln måste skickas för varje anrop för autentisering och auktorisering. Följande egenskap måste vara för HTTP-huvudena.
Nyckel för begärandehuvud Värde
Auktorisering Ange värdet i det här formatet: bearer {API_KEY}
Exempel: bearer eyr....09

Förbrukningsbaserade API:er

En Swagger-slutpunkt finns här för följande API:er. De bör möjliggöra enkel introspektion av API:et och möjligheten att generera klientprogramutvecklingspaket (SDK)s med AutoRest eller Swagger CodeGen. Data från den 1 maj 2014 är tillgängliga via det här API:et.

  • Saldo och sammanfattning – API:et för saldo och sammanfattning ger en månatlig sammanfattning av information om saldon, nya inköp, Azure Marketplace-tjänstavgifter, justeringar och överförbrukningsavgifter.

  • Användningsinformation – API:et för användningsinformation returnerar en daglig uppdelning av förbrukade kvantiteter och beräknade avgifter per registrering. Resultatet innehåller också information om instanser, mätare och avdelningar. Fråga API:et efter faktureringsperiod eller efter ett angivet start- och slutdatum.

  • Marketplace Store-avgift – API:et för Marketplace Store-debitering returnerar den användningsbaserade uppdelningen av marketplace-avgifter per dag för den angivna faktureringsperioden eller start- och slutdatum (engångsavgifter ingår inte).

  • Prisdokument – API:et för prisdokument returnerar relevant pris för respektive mätare för den aktuella registreringen och faktureringsperioden.

  • Information om reserverade instanser – API:et för användning av reserverade instanser returnerar användningsdata om köpta reserverade instanser. API:et för kostnader för reserverade instanser returnerar genomförda betalningstransaktioner.

Dataaktualitet

Etags returneras som svar på alla api:et ovan. En ändring i Etag anger att data har uppdaterats. I efterföljande anrop till samma API med samma parametrar skickar du Etag-filen som hämtats med nyckeln ”If-None-Match” i huvudet för HTTP-begäran. Svarsstatuskoden är NotModified om data inte uppdateras ytterligare och inga data returneras. API returnerar den fullständiga datamängden för den obligatoriska perioden när det sker en etag-ändring.

API:er för hjälpkomponenter

Lista över faktureringsperioder – API:et för faktureringsperioder returnerar en lista över faktureringsperioder som innehåller förbrukningsdata för den angivna registreringen i omvänd kronologisk ordning. Varje period innehåller en egenskap som pekar på API-vägen för de fyra uppsättningarna med data – BalanceSummary, UsageDetails, MarketplaceCharges och PriceSheet.

API-svarskoder

Statuskod för svar Meddelande beskrivning
200 OK Inget fel
400 Felaktig förfrågan Ogiltiga parametrar – datumintervall, EA-nummer osv.
401 Behörighet saknas Det gick inte att hitta API-nyckeln – ogiltig, har gått ut eller liknande
404 Inte tillgänglig Det gick inte att hitta rapportslutpunkten
429 TooManyRequests Begäran begränsades. Vänta så lång tid som anges i rubriken x-ms-ratelimit-microsoft.consumption-retry-after och försök igen.
500 Serverfel Ett oväntat fel inträffade när förfrågan bearbetades
503 ServiceUnavailable Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken Retry-After och försök igen.