Rapporterings-API:er för Enterprise-kunder – Användningsinformation
Anteckning
Den 1 maj 2024 dras Azure Enterprise Reporting API:er tillbaka. Eventuella återstående API:er för Företagsrapportering slutar svara på begäranden. Kunder måste gå över till att använda Api:er för Microsoft Cost Management innan dess. Mer information finns i Översikt över att migrera från Azure Enterprise Reporting till Microsoft Cost Management-API:er.
Det här API:et stöder endast användningsposter med upp till 400 taggtecken för en viss resurs. Ett fel kan inträffa i API:et om posterna överskrider det maximala antalet taggar. Migrera till Exporter eller API:et för export om det här problemet uppstår.
API:et för användningsinformation tillhandahåller en daglig uppdelning av förbrukade kvantiteter och beräknade avgifter per registrering. Resultatet innehåller också information om instanser, mätare och avdelningar. Du kan köra frågor mot API:et baserat på faktureringsperiod eller start- och slutdatum.
I artikeln Översikt över rapporterings-API:er för Enterprise-kunder anges Vanliga rubrikegenskaper som måste läggas till. Anpassade tidsintervall kan anges med parametrarna start- och slutdatum som är i formatet yyyy-MM-dd.
CSV-format
API:et nedan innehåller data i CSV-format.
Synkront anrop (icke-avsökning)
Vi returnerar data i CSV-format som svar på REST API-anropet. API-prestandan är beroende av mängden användningsdata som returneras av ditt anrop och kan ta högst 60 minuter. Även om API:et stöder anpassade datumintervall rekommenderar vi att du begränsar det baserat på mängden användningsdata som du har för den perioden. Vi tillåter högst en månads support.
| Metod | Ladda ned begärande-URI |
|---|---|
| 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 |
Asynkront anrop (avsökningsbaserat)
Anropet är en tvåstegsprocess som kräver att du skickar din begäran först för ett visst tidsintervall och sedan avsöker för att hämta en delad åtkomstnyckelbaserad URL för en Azure Blob-plats som har CSV-data. Den maximala tiden som stöds här är 36 månader. Vi rekommenderar det här API:et för större datamängder.
| Metod | Skicka begärande-URI |
|---|---|
| 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 |
Svar från Asynkront (avsökning) skicka anrop
{
"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"
}
Egenskapsdefinitioner för asynkront anrop
| Egenskapens namn | Typ | Description |
|---|---|---|
| id | sträng | Det unika ID:t för begäran. |
| enrollmentNumber | sträng | Registreringsnumret som begäran gjordes för. |
| requestedOn | sträng | Den datum då begäran gjordes. |
| status | int | Anger status för begäran. Köad = 1, InProgress = 2, Slutförd = 3, Misslyckades = 4, NoDataFound = 5, ReadyToDownload=6, TimedOut = 7. |
| blobPath | sträng | URL:en för den delade åtkomstnyckeln till csv-bloben. |
| reportUrl | sträng | Den URL som kan användas för att söka efter status för skicka begäran. |
| Startdate | sträng | Motsvarar början av det tidsintervall som används när du skickar anropet. |
| endDate | sträng | Motsvarar slutet av det tidsintervall som används när du skickar anropet. |
reportUrl är den URL som kan användas för ytterligare avsökningsanrop (GET-åtgärd). När statusfältet i svaret på avsökningsbegäran kommer tillbaka som 3 slutförs begäran. BlobPath-fältet i svaret är fyllt med en URL som pekar på csv-data. Bloben är tillgänglig i 1 dag från datumtiden i fältet requestedOn i svarsfältet. Status 4, 5 och 7 är felstatus där API-anropet har drabbats av ett feltillstånd. För all annan status bör avsökningsanropet upprepas.
JSON-format
API:et som anges nedan innehåller data i JSON-format. Om ingen faktureringsperiod har angetts returneras data för den aktuella faktureringsperioden. Det maximala tidsintervallet som stöds är 36 månader.
| Metod | URI för förfrågan |
|---|---|
| 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 |
Anteckning
Om du vill använda den tidigare versionen av API:et ersätter du v3 med v2 i URL:erna ovan. Vissa fält är inte tillgängliga om du använder v2.
Svarsåtgärder
På grund av den potentiellt stora datavolymen är resultatuppsättningen växlingsbar. Egenskapen nextLink, om den finns, anger länken för nästa sida med data. Om länken är tom anger den att det är den sista sidan.
{
"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"
}
Fältdefinitioner för användningsinformation
| Egenskapens namn | Typ | Description |
|---|---|---|
| id | sträng | Det unika ID:t för API-anropet. |
| data | JSON-matris | Matrisen med daglig användningsinformation för varje instans/mätare. |
| nextLink | sträng | När det finns fler datasidor pekar nextLink på URL:en för att returnera nästa sida med data. |
| accountId | int | Föråldrat fält. Finns för bakåtkompatibilitet. |
| productId | int | Föråldrat fält. Finns för bakåtkompatibilitet. |
| resourceLocationId | int | Föråldrat fält. Finns för bakåtkompatibilitet. |
| consumedServiceId | int | Föråldrat fält. Finns för bakåtkompatibilitet. |
| departmentId | int | Föråldrat fält. Finns för bakåtkompatibilitet. |
| accountOwnerEmail | sträng | Email konto för kontoinnehavaren. |
| accountName | sträng | Kunden har angett namnet på kontot. |
| serviceAdministratorId | sträng | Email-adressen till tjänstadministratören. |
| subscriptionId | int | Föråldrat fält. Finns för bakåtkompatibilitet. |
| subscriptionGuid | sträng | Global unik identifierare för prenumerationen. |
| subscriptionName | sträng | Namnet på prenumerationen. |
| datum | sträng | Det datum då förbrukningen inträffade. |
| produkt | sträng | Ytterligare information om mätaren. |
| meterId | sträng | Identifieraren för den mätare som genererat användning. |
| meterCategory | sträng | Den Azure-plattformstjänst som användes. |
| meterSubCategory | sträng | Definierar den Azure-tjänsttyp som kan påverka priset. |
| meterRegion | sträng | Anger datacenterplats för vissa tjänster som prissätts beroende på var datacentret ligger. |
| meterName | sträng | Namnet på mätaren. |
| consumedQuantity | double | Mängden av mätaren som har förbrukats. |
| resourceRate | double | Den taxa som gäller per fakturerbar enhet. |
| cost | double | Den avgift som har uppstått för mätaren. |
| resourceLocation | sträng | Identifierar det datacenter där mätaren körs. |
| consumedService | sträng | Den Azure-plattformstjänst som användes. |
| instanceId | sträng | Den här identifieraren är namnet på resursen eller det fullständigt kvalificerade resurs-ID:t. Mer information finns i Azure Resource Manager API |
| serviceInfo1 | sträng | Interna Azure-tjänstmetadata. |
| serviceInfo2 | sträng | Det kan till exempel vara en avbildningstyp för en virtuell dator och ISP-namn för ExpressRoute. |
| additionalInfo | sträng | Tjänstspecifika metadata. Det kan till exempel vara en avbildningstyp för en virtuell dator. |
| tags | sträng | Kunden lade till taggar. Mer information finns i Organisera dina Azure-resurser med taggar. |
| storeServiceIdentifier | sträng | Den här kolumnen används inte. Finns för bakåtkompatibilitet. |
| departmentName | sträng | Avdelningens namn. |
| costCenter | sträng | Det kostnadsställe som användningen är associerad med. |
| unitOfMeasure | sträng | Identifierar i vilken enhet tjänsten debiteras. Exempel: GB, timmar, 10 000 s. |
| resourceGroup | sträng | Resursgruppen där den distribuerade mätaren körs. Mer information finns i Översikt över Azure Resource Manager. |
| chargesBilledSeparately | sträng | Avgifter som debiteras utanför det ekonomiska åtagandet. |
| location | sträng | Plats där tjänsten distribuerades. |
| offerId | sträng | OfferId mot tjänsten. |
| partNumber | sträng | SKU-nummer för tjänsten. |
| resourceGuid | sträng | Identifieraren för den mätare som genererat användning. |
| serviceTier | sträng | Tjänstnivå. |
| Tjänstnamn | sträng | Tjänstnamn. |
Hastighetsbegränsning
För att möjliggöra konsekventa upplevelser för våra kunder är alla användnings-API:er frekvensbegränsade på registreringsnivå. När du når gränsen får du HTTP-statuskoden 429 För många begäranden. Det aktuella dataflödet inom ett intervall på 15 minuter är som nedan:
| API | Frekvensgräns |
|---|---|
| NextPage | 1000 |
| Ladda ned | 50 |
| Enkät | 180 |
| Skicka | 20 |