Rapportage-API's voor Enterprise-klanten - gebruiksgegevens
Notitie
Op 1 mei 2024 worden Azure Enterprise Reporting-API's buiten gebruik gesteld. Alle resterende Enterprise Reporting-API's reageren niet meer op aanvragen. Klanten moeten voor die tijd overstappen op het gebruik van Microsoft Cost Management-API's. Zie Overzicht van Azure Enterprise Reporting naar Microsoft Cost Management API's migreren voor meer informatie.
Deze API ondersteunt alleen gebruiksrecords met maximaal 400 tagtekens voor een bepaalde resource. De API kan mislukken als u records hebt die het maximumaantal tags overschrijden. Als u dit probleem ervaart, migreert u naar Exporten of de Export-API.
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. Via de API kunnen gegevens worden opgevraagd per factureringsperiode of aan de hand van een opgegeven begin- en einddatum.
Welke algemene headereigenschappen moeten worden toegevoegd, staat in het artikel Overzicht van rapportage-API's voor Enterprise-klanten. Aangepaste tijdsbereiken kunnen worden opgegeven met de begin- en einddatumparameters die de notatie jjjj-MM-dd hebben.
CSV-indeling
De onderstaande API biedt gegevens in CSV-indeling.
Synchrone aanroep (niet-polling)
We retourneren gegevens in CSV-indeling als reactie op de REST API-aanroep. De API-prestaties zijn afhankelijk van de hoeveelheid gebruiksgegevens die door uw aanroep worden geretourneerd en kunnen maximaal 60 minuten duren. Hoewel de API aangepaste datumbereiken ondersteunt, raden we u aan deze te beperken op basis van de hoeveelheid gebruiksgegevens die u voor die periode hebt. Ondersteuning van maximaal één maand is toegestaan.
| Methode | Aanvraag-URI downloaden |
|---|---|
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/download?billingPeriod={billingPeriod} |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/download?startTime=2017-01-01& endTime=2017-01-10 |
Asynchrone aanroep (op basis van polling)
De aanroep is een proces in twee stappen waarbij u eerst uw aanvraag moet indienen voor een specifiek tijdsbereik en vervolgens een poll moet uitvoeren om een url op basis van een gedeelde toegangssleutel op te halen voor een Azure Blob-locatie met CSV-gegevens. De maximaal ondersteunde tijd is hier 36 maanden. We raden deze API aan voor grotere gegevenssets.
| Methode | Aanvraag-URI verzenden |
|---|---|
| POST | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/submit?billingPeriod={billingPeriod} |
| POST | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/submit?startTime=2017-04-01& endTime=2017-04-10 |
Antwoord van asynchrone (polling) verzendoproep
{
"id": "string",
"enrollmentNumber":"string",
"requestedOn":"2017-08-29T06:56:29.1290704Z",
"status":1,
"blobPath":"",
"reportUrl":"string",
"startDate":"2017-06-01T00:00:00",
"endDate":"2017-06-30T00:00:00"
}
Asynchrone aanroepantwoord eigenschapsdefinities
| Eigenschapsnaam | Type | Beschrijving |
|---|---|---|
| id | tekenreeks | De unieke id voor de aanvraag. |
| enrollmentNumber | tekenreeks | Het inschrijvingsnummer waarvoor de aanvraag is ingediend. |
| requestedOn | tekenreeks | De datum waarop de aanvraag is ingediend. |
| status | int | Geeft de status van de aanvraag aan. In wachtrij = 1, InProgress = 2, Completed = 3, Failed = 4, NoDataFound = 5, ReadyToDownload=6, TimedOut = 7. |
| blobPath | tekenreeks | De URL van de gedeelde toegangssleutel naar de CSV-blob. |
| reportUrl | tekenreeks | De URL die kan worden gebruikt om de status van de aanvraag te peilen. |
| startDate | tekenreeks | Komt overeen met het begin van het tijdsbereik dat is gebruikt tijdens het verzenden van de aanroep. |
| endDate | tekenreeks | Komt overeen met het einde van het tijdsbereik dat is gebruikt tijdens het verzenden van de aanroep. |
De reportUrl is de URL die kan worden gebruikt voor verdere polling-aanroepen (GET-bewerking). Wanneer het statusveld in het antwoord van de polling-aanvraag terugkomt als 3, wordt de aanvraag voltooid. We hebben het blobPath-veld in het antwoord ingevuld met een URL die verwijst naar de CSV-gegevens. De blob is gedurende 1 dag beschikbaar vanaf de datum/tijd in het antwoordveld requestedOn. Status 4, 5 en 7 zijn de foutstatus waarbij de API-aanroep een foutvoorwaarde heeft bereikt. Voor alle andere statussen moet de polling-aanroep worden herhaald.
JSON-indeling
De onderstaande API biedt gegevens in JSON-indeling. Als er geen factureringsperiode is opgegeven, worden de gegevens voor de huidige factureringsperiode geretourneerd. Het maximaal ondersteunde tijdsbereik is 36 maanden.
| Methode | Aanvraag-URI |
|---|---|
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/usagedetails |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetailsbycustomdate?startTime=2017-01-01& endTime=2017-01-10 |
Notitie
Als u de vorige versie van de API wilt gebruiken, vervangt u v3 door v2 in de bovenstaande URL's. Sommige velden zijn niet beschikbaar als u v2 gebruikt.
Antwoord
Vanwege de potentieel grote hoeveelheid gegevens wordt de resultatenset gepaginad. De eigenschap nextLink, indien aanwezig, geeft de koppeling voor de volgende pagina met gegevens op. Als de koppeling leeg is, geeft dit aan dat het de laatste pagina is.
{
"id": "string",
"data": [
{
"serviceName":"Storage",
"serviceTier":"Premium Page Blobs",
"location":"US West",
"chargesBilledSeparately":false,
"partNumber":"ABC-12345",
"resourceGuid":"00000000-0000-0000-0000-000000000000",
"offerId":"MS-AZR-0003P",
"cost":1,
"accountId":123456,
"productId":1234,
"resourceLocationId":12,
"consumedServiceId":1,
"departmentId":3456,
"accountOwnerEmail":"account@live.com",
"accountName":"Account Name",
"serviceAdministratorId":"123",
"subscriptionId":0000000,
"subscriptionGuid":"00000000-0000-0000-0000-000000000000",
"subscriptionName":"Subscription Name",
"date":"2018-08-01T00:00:00",
"product":"Locally Redundant Storage Premium Storage - Page Blob/P10 - US West",
"meterId":"00000000-0000-0000-0000-000000000000",
"meterCategory":"Storage",
"meterSubCategory":"Locally Redundant",
"meterRegion":"California",
"meterName":"Premium Storage - Page Blob/P10 (Units)",
"consumedQuantity"1,
"resourceRate":1,
"resourceLocation":"uswest",
"consumedService":"Microsoft.Compute",
"instanceId":"Id",
"serviceInfo1":"string",
"serviceInfo2":"string",
"additionalInfo":"string",
"tags":"string",
"storeServiceIdentifier":"string",
"departmentName":"Department Name",
"costCenter":"1234",
"unitOfMeasure":"Units",
"resourceGroup":"ResourceGroup"
}
],
"nextLink": "string"
}
Velddefinities voor gebruiksgegevens
| Eigenschapsnaam | Type | Beschrijving |
|---|---|---|
| id | tekenreeks | De unieke id voor de API-aanroep. |
| gegevens | JSON-matrix | De matrix met dagelijkse gebruiksgegevens voor elke instantie\meter. |
| nextLink | tekenreeks | Wanneer er meer pagina's met gegevens zijn, verwijst de nextLink naar de URL om de volgende pagina met gegevens te retourneren. |
| accountId | int | Verouderd veld. Aanwezig voor compatibiliteit met eerdere versies. |
| productId | int | Verouderd veld. Aanwezig voor compatibiliteit met eerdere versies. |
| resourceLocationId | int | Verouderd veld. Aanwezig voor compatibiliteit met eerdere versies. |
| consumedServiceId | int | Verouderd veld. Aanwezig voor compatibiliteit met eerdere versies. |
| departmentId | int | Verouderd veld. Aanwezig voor compatibiliteit met eerdere versies. |
| accountOwnerEmail | tekenreeks | Email account van de accounteigenaar. |
| accountName | tekenreeks | De klant heeft de naam van het account ingevoerd. |
| serviceAdministratorId | tekenreeks | Email adres van servicebeheerder. |
| subscriptionId | int | Verouderd veld. Aanwezig voor compatibiliteit met eerdere versies. |
| subscriptionGuid | tekenreeks | Globale unieke id voor het abonnement. |
| subscriptionName | tekenreeks | Naam van het abonnement. |
| datum | tekenreeks | De datum waarop het verbruik heeft plaatsgevonden. |
| product | tekenreeks | Aanvullende informatie over de meter. |
| meterId | tekenreeks | De id voor de meter die het gebruik heeft verzonden. |
| meterCategory | tekenreeks | De Azure-platformservice die is gebruikt. |
| meterSubCategory | tekenreeks | Definieert het Azure-servicetype dat van invloed kan zijn op de snelheid. |
| meterRegion | tekenreeks | De datacenterlocatie voor bepaalde services waarbij de prijs is gebaseerd op de datacenterlocatie. |
| meterName | tekenreeks | Naam van de meter. |
| consumedQuantity | double | De hoeveelheid van de meter die is verbruikt. |
| resourceRate | double | Het tarief dat van toepassing is per factureerbare eenheid. |
| cost | double | De kosten die in rekening zijn gebracht voor de meter. |
| resourceLocation | tekenreeks | Identificeert het datacenter waar de meter wordt uitgevoerd. |
| consumedService | tekenreeks | De Azure-platformservice die is gebruikt. |
| instanceId | tekenreeks | Deze id is de naam van de resource of de volledig gekwalificeerde resource-id. Zie Azure Resource Manager API voor meer informatie |
| serviceInfo1 | tekenreeks | Interne metagegevens van azure-service. |
| serviceInfo2 | tekenreeks | Bijvoorbeeld een afbeeldingstype voor een virtuele machine en ISP-naam voor ExpressRoute. |
| additionalInfo | tekenreeks | Servicespecifieke metagegevens. Bijvoorbeeld een installatiekopie voor een virtuele machine. |
| tags | tekenreeks | Klant heeft tags toegevoegd. Zie Uw Azure-resources organiseren met tags voor meer informatie. |
| storeServiceIdentifier | tekenreeks | Deze kolom wordt niet gebruikt. Aanwezig voor compatibiliteit met eerdere versies. |
| departmentName | tekenreeks | Naam van de afdeling. |
| costCenter | tekenreeks | De kostenplaats waaraan het gebruik is gekoppeld. |
| unitOfMeasure | tekenreeks | Hiermee wordt de eenheid geïdentificeerd waarin de service wordt gefactureerd. Voorbeeld: GB, uren, 10.000 s. |
| resourceGroup | tekenreeks | De resourcegroep waarin de geïmplementeerde meter wordt uitgevoerd. Zie Overzicht van Azure Resource Manager voor meer informatie. |
| chargesBilledSeparately | tekenreeks | Kosten die buiten de financiële toezegging worden gefactureerd. |
| location | tekenreeks | Locatie waar de service is geïmplementeerd. |
| offerId | tekenreeks | OfferId op basis van de service. |
| partNumber | tekenreeks | SKU-nummer voor de service. |
| resourceGuid | tekenreeks | De id voor de meter die het gebruik heeft verzonden. |
| serviceTier | tekenreeks | Servicelaag. |
| Servicenaam | tekenreeks | Servicenaam. |
Snelheidsbeperking
Om consistente ervaringen voor onze klanten mogelijk te maken, hebben alle gebruiks-API's een frequentielimiet op inschrijvingsniveau. Wanneer u de limiet bereikt, ontvangt u de HTTP-statuscode 429 Te veel aanvragen. De huidige doorvoer in een interval van 15 minuten is zoals hieronder:
| API | Frequentielimiet |
|---|---|
| Nextpage | 1000 |
| Downloaden | 50 |
| Poll | 180 |
| Verzenden | 20 |