Overzicht van de Rapportage-API's van Azure Enterprise

  • Artikel

Notitie

Alle Azure Enterprise Reporting-API's worden buiten gebruik gesteld. U moet zo snel mogelijk migreren naar Microsoft Cost Management-API's .

Met de Azure Enterprise Reporting-API's kunnen Enterprise Azure-klanten programmatisch verbruiks- en factureringsgegevens ophalen in hulpprogramma's voor analyse van voorkeursgegevens. Enterprise-klanten ondertekenden een Enterprise Overeenkomst (EA) met Azure om onderhandelde Azure-vooruitbetaling (voorheen financiële toezegging genoemd) te maken en toegang te krijgen tot aangepaste prijzen voor Azure-resources.

Alle parameters voor datum en tijd die zijn vereist voor API’s, moeten worden weergegeven in UTC-waarden (Coordinated Universal Time). Waarden die worden geretourneerd via API’s, hebben de UTC-indeling.

Gegevenstoegang tot de API inschakelen

  • Genereer of haal de API-sleutel op. Zie API-sleutel genereren voor meer informatie.
  • Sleutels doorgeven aan de API: de API-sleutel moet voor elke aanroep worden door gegeven voor verificatie en autorisatie. De volgende eigenschap moet naar de HTTP-headers zijn.
Aanvraagheadersleutel Weergegeven als
Autorisatie Geef de waarde in deze indeling op: bearer {API_SLEUTEL}
Voorbeeld: bearer eyr....09

API's op basis van verbruik

Hier is een Swagger-eindpunt beschikbaar voor de volgende API's. Ze moeten eenvoudige introspectie van de API mogelijk maken en de mogelijkheid om sdk's (client software development kits) te genereren met behulp van AutoRest of Swagger CodeGen. Gegevens vanaf 1 mei 2014 zijn beschikbaar via deze API.

  • Saldo en overzicht : de API saldo en overzicht biedt een maandelijks overzicht van informatie over saldo's, nieuwe aankopen, Azure Marketplace-servicekosten, aanpassingen en overschrijdingskosten.

  • Gebruiksgegevens: de API voor gebruiksgegevens biedt een dagelijkse uitsplitsing van de verbruikte hoeveelheden en de geschatte kosten per inschrijving. Het resultaat bevat ook informatie over instanties, meters en afdelingen. Voer een query uit op de API op factureringsperiode of op een opgegeven begin- en einddatum.

  • Marketplace Store-kosten : de MARKETPLACE Store-kosten-API retourneert de op gebruik gebaseerde marketplace-kosten per dag voor de opgegeven factureringsperiode of de begin- en einddatum (eenmalige kosten zijn niet inbegrepen).

  • Prijzenoverzicht: de API voor prijzenoverzicht biedt het toepasselijke tarief voor elke meter voor de aangegeven inschrijvings- en factureringsperiode.

  • Details van gereserveerde instantie: de API voor het gebruik van gereserveerde instanties retourneert het gebruik van de aankopen van gereserveerde instanties. De API voor kosten van gereserveerde instanties toont de gemaakte factureringstransacties.

Nieuwheid van gegevens

Etags worden geretourneerd in het antwoord van alle bovenstaande API's. Een wijziging in Etag geeft aan dat de gegevens zijn vernieuwd. In volgende aanroepen naar dezelfde API met dezelfde parameters geeft u de vastgelegde Etag door met de sleutel 'If-None-Match' in de header van de HTTP-aanvraag. De antwoordstatuscode is NotModified als de gegevens niet verder worden vernieuwd en er geen gegevens worden geretourneerd. DE API retourneert de volledige gegevensset voor de vereiste periode wanneer er een etagwijziging is.

Helper-API's

Factureringsperioden opvragen: de API voor factureringsperioden retourneert een lijst met factureringsperioden met verbruiksgegevens voor een inschrijving (in omgekeerd chronologische volgorde). Elke periode bevat een eigenschap die verwijst naar de API-route voor de vier sets gegevens: BalanceSummary, UsageDetails, Marketplace Charges en Price Sheet.

API-responscodes

Statuscode respons Bericht Beschrijving
200 OK Geen fout
400 Onjuiste aanvraag Ongeldige parameters: datumbereiken, EA-nummers, enzovoort.
401 Niet geautoriseerd De API-sleutel is niet gevonden, is ongeldig, is verlopen, enzovoort.
404 Niet beschikbaar Rapporteindpunt niet gevonden
429 TooManyRequests De aanvraag is beperkt. Probeer het opnieuw nadat u de tijd hebt gewacht die in de header x-ms-ratelimit-microsoft.consumption-retry-after wordt opgegeven.
500 Serverfout Er is een onverwachte fout opgetreden bij het verwerken van de aanvraag
503 ServiceUnavailable De service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u de tijd hebt gewacht die in de header Retry-After wordt opgegeven.