Panoramica delle API di creazione di report per i clienti EnterpriseOverview of Reporting APIs for Enterprise customers

Le API di creazione di report consentono ai clienti Enterprise di Azure di estrarre i dati di fatturazione e sull'uso a livello di codice per inserirli negli strumenti di analisi preferiti.The Reporting APIs enable Enterprise Azure customers to programmatically pull consumption and billing data into preferred data analysis tools.

Abilitazione dell'API per l'accesso ai datiEnabling data access to the API

  • Generare o recuperare la chiave API: accedere a Enterprise Portal e passare a Report > Scarica utilizzo > API Access Key (Chiave di accesso API) per generare o recuperare la chiave API.Generate or retrieve the API key - Log in to the Enterprise portal, and navigate to Reports > Download Usage > API Access Key to generate or retrieve the API key.
  • Passare le chiavi nell'API - La chiave API deve essere passata per ogni chiamata per l'autenticazione e l'autorizzazione.Passing keys in the API - The API key needs to be passed for each call for Authentication and Authorization. La proprietà seguente deve essere passata alle intestazioni HTTP:The following property needs to be to the HTTP headers
Chiave intestazione necessariaRequest Header Key ValoreValue
AuthorizationAuthorization Specificare il valore nel formato: bearer {API_KEY}Specify the value in this format: bearer {API_KEY}
Esempio: bearer eyr....09Example: bearer eyr....09

API per l'usoConsumption APIs

Per le API descritte di seguito, qui è disponibile un endpoint Swagger che deve consentire una facile analisi dell'API e la possibilità di generare SDK client tramite AutoRest o Swagger CodeGen.A Swagger endpoint is available here for the APIs described below which should enable easy introspection of the API and the ability to generate client SDKs using AutoRest or Swagger CodeGen. I dati a partire dal 1° maggio 2014 sono disponibili tramite questa API.Data beginning May 1, 2014 is available through this API.

  • Saldi e riepilogo - L'API per saldi e riepilogo offre un riepilogo mensile delle informazioni su saldi, nuovi acquisti, addebiti per il servizio Azure Marketplace e spese per modifiche e da pagare in eccedenza.Balance and Summary - The Balance and Summary API offers a monthly summary of information on balances, new purchases, Azure Marketplace service charges, adjustments and overage charges.

  • Dettagli sull'uso - L'API per dettagli sull'uso offre un'analisi giornaliera dettagliata delle quantità usate e delle spese stimate in relazione a una registrazione.Usage Details - The Usage Detail API offers a daily breakdown of consumed quantities and estimated charges by an Enrollment. Il risultato include anche informazioni su istanze, contatori e reparti.The result also includes information on instances, meters and departments. Le query sull'API possono essere eseguite in base al periodo di fatturazione oppure in base a un intervallo definito da date di inizio e di fine specificate.The API can be queried by Billing period or by a specified start and end date.

  • Spese per Marketplace Store - L'API per le spese in Marketplace Store restituisce le spese giornaliere dettagliate in base all'uso correlate al Marketplace per il periodo di fatturazione specificato o per le date di inizio e fine indicate (le spese una tantum non sono incluse).Marketplace Store Charge - The Marketplace Store Charge API returns the usage-based marketplace charges breakdown by day for the specified Billing Period or start and end dates (one time fees are not included).

  • Elenco prezzi - L'API elenco prezzi offre la tariffa applicabile per ogni contatore per la registrazione e il periodo di fatturazione specificati.Price Sheet - The Price Sheet API provides the applicable rate for each Meter for the given Enrollment and Billing Period.

Aggiornamento dei datiData Freshness

Vengono restituiti ETag in risposta a tutte le API indicate in precedenza.Etags will be returned in the response of all the above API. Una modifica di ETag indica che i dati sono stati aggiornati.A change in Etag indicates the data has been refreshed. Nelle chiamate successive alla stessa API tramite gli stessi parametri passare l'ETag acquisito con la chiave "If-None-Match" nell'intestazione della richiesta http.In subsequent calls to the same API using the same parameters, pass the captured Etag with the key “If-None-Match” in the header of http request. Il codice di stato della risposta sarà "NotModified" se i dati non sono stati aggiornati ulteriormente e non verrà restituito alcun dato.The response status code would be "NotModified" if the data has not been refreshed any further and no data will be returned. L'API restituirà il set di dati completo per il periodo richiesto a ogni modifica di ETag.API will return the full dataset for the required period whenever there is an etag change.

API di supportoHelper APIs

Elenco periodi di fatturazione - L'API per periodi di fatturazione restituisce un elenco di periodi di fatturazione contenente i dati sull'uso per la registrazione specificata in ordine cronologico inverso.List Billing Periods - The Billing Periods API returns a list of billing periods that have consumption data for the specified Enrollment in reverse chronological order. Ogni periodo contiene una proprietà che punta alla route API per i quattro set di dati, ovvero BalanceSummary, UsageDetails, MarketplaceCharges e PriceSheet.Each Period contains a property pointing to the API route for the four sets of data - BalanceSummary, UsageDetails, Marketplace Charges, and Price Sheet.

Codici di risposta dell'APIAPI Response Codes

Codice di stato della rispostaResponse Status Code MessageMessage DESCRIZIONEDescription
200200 OKOK Nessun erroreNo error
401401 Non autorizzataUnauthorized Chiave API non trovata, non valida, scaduta e così viaAPI Key not found, Invalid, Expired etc.
404404 Non disponibileUnavailable Endpoint del report non trovatoReport endpoint not found
400400 Bad RequestBad Request Parametri non validi (intervalli di date, numeri EA e così via)Invalid params – Date ranges, EA numbers etc.
500500 Errore del serverServer Error Errore imprevisto nell'elaborazione della richiestaUnexoected error processing request