Berichterstellungs-APIs für Unternehmenskunden – Verwendungsdetails
Hinweis
Am 1. Mai 2024 werden Azure Enterprise Reporting-APIs eingestellt. Alle verbleibenden Enterprise Reporting-APIs reagieren nicht mehr auf Anforderungen. Kunden müssen bis dahin zur Verwendung von Microsoft Cost Management-APIs wechseln. Weitere Informationen finden Sie unter Übersicht über die Migration von der Berichterstellung mit Azure Enterprise zu Kostenverwaltungs-APIs von Microsoft.
Diese API unterstützt nur Verwendungsdatensätze mit bis zu 400 Tagzeichen für eine bestimmte Ressource. Die API schlägt möglicherweise fehl, wenn Datensätze die maximale Anzahl von Tags überschreiten. Wenn dieses Problem auftritt, migrieren Sie zu Exporte oder zur Exports-API.
API für Verwendungsdetails bietet eine tägliche Aufschlüsselung der verbrauchten Mengen und durch eine Registrierung anfallenden geschätzten Kosten. Das Ergebnis umfasst auch Informationen zu Instanzen, Verbrauchseinheiten und Abteilungen. Die API kann nach Abrechnungszeitraum oder einem angegebenen Start- und Enddatum abgefragt werden.
Allgemeine Headereigenschaften, die hinzugefügt werden müssen, finden Sie im Artikel mit der Übersicht über die Berichterstellungs-APIs für Unternehmenskunden. Benutzerdefinierte Zeitabschnitte können mit den Parameter für Start- und Enddatum im Format JJJJ-MM-TT angegeben werden.
CSV-Format
Die unten aufgeführte API stellt Daten im CSV-Format bereit.
Synchroner Aufruf (nicht abruft)
Wir geben Daten im CSV-Format als Antwort des REST-API-Aufrufs zurück. Die API-Leistung hängt von der Menge der von Ihrem Aufruf zurückgegebenen Nutzungsdaten ab und kann maximal 60 Minuten dauern. Obwohl die API benutzerdefinierte Datumsbereiche unterstützt, empfehlen wir, sie basierend auf der Menge der Nutzungsdaten für diesen Zeitraum einzuschränken. Wir erlauben maximal einen Monat Support.
| Methode | Anforderungs-URI herunterladen |
|---|---|
| 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 |
Asynchroner Aufruf (abrufbasiert)
Bei dem Aufruf handelt es sich um einen zweistufigen Prozess, bei dem Sie Ihre Anforderung zuerst für einen bestimmten Zeitbereich übermitteln und dann abfragen müssen, um eine freigegebene Zugriffsschlüssel-basierte URL für einen Azure-Blobspeicherort mit CSV-Daten abzurufen. Die maximale unterstützte Zeit, die hier angerufen wird, beträgt 36 Monate. Wir empfehlen diese API für größere Datasets.
| Methode | Anforderungs-URI übermitteln |
|---|---|
| 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 |
Antwort des asynchronen Aufrufs (Abruf)
{
"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"
}
Response-Eigenschaftsdefinitionen für asynchrone Aufrufe
| Eigenschaftenname | type | BESCHREIBUNG |
|---|---|---|
| id | Zeichenfolge | Die eindeutige ID für die Anforderung. |
| enrollmentNumber | Zeichenfolge | Die Registrierungsnummer, für die die Anforderung gestellt wurde. |
| requestedOn | Zeichenfolge | Das Datum, zu dem die Anforderung gestellt wurde. |
| status | INT | Gibt die status der Anforderung an. Queued = 1, InProgress = 2, Completed = 3, Failed = 4, NoDataFound = 5, ReadyToDownload=6, TimedOut = 7. |
| blobPath | Zeichenfolge | Die URL des freigegebenen Zugriffsschlüssels für das CSV-Blob. |
| reportUrl | Zeichenfolge | Die URL, die zum Abfragen der status der Übermittlungsanforderung verwendet werden kann. |
| startDate | Zeichenfolge | Entspricht dem Beginn des Zeitbereichs, der während des Übermittlungsaufrufs verwendet wurde. |
| endDate | Zeichenfolge | Entspricht dem Ende des Zeitbereichs, der während des Übermittlungsaufrufs verwendet wurde. |
ReportUrl ist die URL, die für weitere Abrufaufrufe (GET-Vorgang) verwendet werden kann. Wenn das Feld status in der Antwort der Abfrageanforderung als 3 zurückgibt, wird die Anforderung abgeschlossen. Das Feld blobPath in der Antwort wird mit einer URL aufgefüllt, die auf die CSV-Daten verweist. Das Blob ist für einen Tag ab dem Datumszeitpunkt im Feld der Antwort angefordert Verfügbar. Status 4, 5 und 7 sind Fehler status, bei denen der API-Aufruf eine Fehlerbedingung erreicht hat. Für alle anderen status sollte der Abruf wiederholt werden.
JSON-Format
Die unten aufgeführte API stellt Daten im JSON-Format bereit. Wenn kein Abrechnungszeitraum angegeben wurde, werden die Daten für den aktuellen Abrechnungszeitraum zurückgegeben. Der maximal unterstützte Zeitraum beträgt 36 Monate.
| Methode | Anforderungs-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 |
Hinweis
Um die vorherige Version der API zu verwenden, ersetzen Sie v3 in den oben genannten URLs durch v2. Einige Felder sind nicht verfügbar, wenn Sie v2 verwenden.
Antwort
Aufgrund der potenziell großen Datenmengen wird das Resultset ausgelagert. Die Eigenschaft „nextLink“ (sofern vorhanden) gibt den Link für die nächste Seite der Daten an. Wenn der Link leer ist, weist dies darauf hin, dass es sich um die letzte Seite handelt.
{
"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"
}
Felddefinitionen für Nutzungsdetails
| Eigenschaftenname | type | BESCHREIBUNG |
|---|---|---|
| id | Zeichenfolge | Eindeutige ID für den API-Aufruf |
| data | JSON-Array | Array der täglichen Verwendungsdetails für jede Instanz/Verbrauchseinheit. |
| nextLink | Zeichenfolge | Wenn weitere Seiten mit Daten vorhanden sind, verweist nextLink auf die URL, mit der die nächste Seite zurückgegeben wird. |
| accountId | INT | Veraltetes Feld. Aus Gründen der Abwärtskompatibilität vorhanden. |
| productId | INT | Veraltetes Feld. Aus Gründen der Abwärtskompatibilität vorhanden. |
| resourceLocationId | INT | Veraltetes Feld. Aus Gründen der Abwärtskompatibilität vorhanden. |
| consumedServiceId | INT | Veraltetes Feld. Aus Gründen der Abwärtskompatibilität vorhanden. |
| departmentId | INT | Veraltetes Feld. Aus Gründen der Abwärtskompatibilität vorhanden. |
| accountOwnerEmail | Zeichenfolge | E-Mail-Konto des Kontoinhabers. |
| . | Zeichenfolge | Vom Kunden eingegebener Name des Kontos. |
| serviceAdministratorId | Zeichenfolge | E-Mail-Adresse des Dienstadministrators. |
| subscriptionId | INT | Veraltetes Feld. Aus Gründen der Abwärtskompatibilität vorhanden. |
| subscriptionGuid | Zeichenfolge | Globally Unique Identifier für das Abonnement. |
| subscriptionName | Zeichenfolge | Name des Abonnements. |
| date | Zeichenfolge | Datum, an dem die Nutzung aufgetreten ist. |
| product | Zeichenfolge | Weitere Details zur Verbrauchseinheit. |
| meterId | Zeichenfolge | Bezeichner für die Verbrauchseinheit, die die Nutzung ausgegeben hat. |
| meterCategory | Zeichenfolge | Verwendeter Azure-Plattformdienst. |
| meterSubCategory | Zeichenfolge | Definiert den Typ des Azure-Diensts, der sich auf den Tarif auswirken kann. |
| meterRegion | Zeichenfolge | Gibt den Standort des Rechenzentrums für bestimmte Dienste an, die basierend auf dem Standort des Rechenzentrums berechnet werden. |
| meterName | Zeichenfolge | Name der Verbrauchseinheit. |
| consumedQuantity | double | Menge der Verbrauchseinheit, die verbraucht wurde. |
| resourceRate | double | Zutreffende Rate pro abrechenbare Einheit. |
| cost | double | Gebühr, die für die Verbrauchseinheit aufgekommen ist. |
| resourceLocation | Zeichenfolge | Gibt das Rechenzentrum an, in dem die Verbrauchseinheit ausgeführt wird. |
| consumedService | Zeichenfolge | Verwendeter Azure-Plattformdienst. |
| instanceId | Zeichenfolge | Dieser Bezeichner ist entweder der Name der Ressource oder die vollqualifizierte Ressourcen-ID. Weitere Informationen finden Sie unter Azure Resource Manager-API. |
| serviceInfo1 | Zeichenfolge | Interne Azure-Dienstmetadaten. |
| serviceInfo2 | Zeichenfolge | Beispielsweise ein Imagetyp für einen virtuellen Computer und ein ISP-Name für ExpressRoute. |
| additionalInfo | Zeichenfolge | Dienstspezifische Metadaten. Dies kann beispielsweise ein Imagetyp für einen virtuellen Computer sein. |
| tags | Zeichenfolge | Vom Kunden hinzugefügte Tags. Weitere Informationen finden Sie unter Organisieren von Azure-Ressourcen mit Tags. |
| storeServiceIdentifier | Zeichenfolge | Diese Spalte wird nicht verwendet. Aus Gründen der Abwärtskompatibilität vorhanden. |
| departmentName | Zeichenfolge | Name der Abteilung. |
| costCenter | Zeichenfolge | Kostenstelle, der die Nutzung zugeordnet ist. |
| unitOfMeasure | Zeichenfolge | Gibt die Einheit an, in der der Dienst in Rechnung gestellt wird. Beispiel: GB, Stunden, 10.000 s. |
| resourceGroup | Zeichenfolge | Die Ressourcengruppe, in der die bereitgestellte Verbrauchseinheit ausgeführt wird. Weitere Informationen finden Sie unter Übersicht über den Azure Resource Manager. |
| chargesBilledSeparately | Zeichenfolge | Gebühren, die außerhalb der monetären Verpflichtung in Rechnung gestellt werden. |
| location | Zeichenfolge | Speicherort, an dem der Dienst bereitgestellt wurde. |
| offerId | Zeichenfolge | OfferId für den Dienst. |
| partNumber | Zeichenfolge | SKU-Nummer für den Dienst. |
| resourceGuid | Zeichenfolge | Bezeichner für die Verbrauchseinheit, die die Nutzung ausgegeben hat. |
| serviceTier | Zeichenfolge | Dienstebene. |
| serviceName | Zeichenfolge | Service Name. |
Ratenbegrenzung
Um konsistente Erfahrungen für unsere Kunden zu ermöglichen, sind alle Nutzungs-APIs auf Registrierungsebene begrenzt. Wenn Sie den Grenzwert erreichen, erhalten Sie den HTTP-Statuscode 429 Zu viele Anforderungen. Der aktuelle Durchsatz in einem Intervall von 15 Minuten ist wie folgt:
| API | Ratenlimit |
|---|---|
| Nextpage | 1000 |
| Herunterladen | 50 |
| Abruf | 180 |
| Übermitteln | 20 |