Rozhraní API pro vytváření sestav pro podnikové zákazníky – Podrobnosti využití
Poznámka
1. května 2024 budou rozhraní API pro generování sestav Azure Enterprise vyřazena. Všechna zbývající rozhraní API služby Enterprise Reporting přestanou reagovat na požadavky. Zákazníci musí do té doby přejít na používání rozhraní API služby Microsoft Cost Management. Další informace najdete v tématu Přehled migrace z rozhraní API služby Azure Enterprise Reporting na rozhraní API služby Microsoft Cost Management.
Toto rozhraní API podporuje pouze záznamy o využití s maximálně 400 znaky značek pro daný prostředek. Toto rozhraní API může selhat, pokud záznamy překročí maximální počet značek. Pokud se tento problém vyskytne, přejděte k exportům nebo rozhraní API pro export.
Rozhraní API Podrobnosti o využití nabízí denní rozpis spotřebovaných prostředků a odhadované poplatky podle registrace. Výsledek obsahuje také informace o instancích, měřičích a odděleních. Na rozhraní API je možné zadávat dotazy podle fakturačního období nebo podle zadaného počátečního a koncového data.
Běžné vlastnosti hlaviček, které je třeba přidat, jsou uvedené v článku Přehled rozhraní API pro vytváření sestav pro podnikové zákazníky. Vlastní časové rozsahy je možné zadat pomocí parametrů počátečního a koncového data ve formátu rrrr-MM-dd.
Formát CSV
Níže uvedené rozhraní API poskytuje data ve formátu CSV.
Synchronní volání (bez dotazování)
Jako odpověď na volání rozhraní REST API vracíme data ve formátu CSV. Výkon rozhraní API závisí na množství dat o využití vrácených voláním a může trvat maximálně 60 minut. I když rozhraní API podporuje vlastní rozsahy kalendářních dat, doporučujeme ho omezit na základě objemu dat o využití, které máte pro dané období. Povolujeme maximálně měsíční podporu.
| Metoda | Identifikátor URI žádosti o stažení |
|---|---|
| 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 |
Asynchronní volání (založené na dotazování)
Volání je dvoustupňový proces, který vyžaduje, abyste nejprve odeslali žádost pro konkrétní časový rozsah a pak se dotázali, abyste získali adresu URL založenou na sdíleném přístupovém klíči pro umístění objektů blob Azure, které obsahuje data CSV. Maximální podporovaná doba je 36 měsíců. Toto rozhraní API doporučujeme pro větší datové sady.
| Metoda | Identifikátor URI požadavku pro odeslání |
|---|---|
| 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 |
Odpověď asynchronního volání (dotazování) odeslání
{
"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"
}
Definice vlastností odpovědi asynchronního volání
| Název vlastnosti | Typ | Description |
|---|---|---|
| id | řetězec | Jedinečné ID požadavku. |
| enrollmentNumber | řetězec | Číslo registrace, pro které byla žádost provedena. |
| requestedOn | řetězec | Datum a čas, kdy byla žádost podána. |
| status | int | Označuje stav požadavku. Ve frontě = 1, InProgress = 2, Completed = 3, Failed = 4, NoDataFound = 5, ReadyToDownload=6, TimedOut = 7. |
| blobPath | řetězec | Adresa URL sdíleného přístupového klíče pro objekt blob csv |
| reportUrl | řetězec | Adresa URL, kterou lze použít k dotazování na stav odeslání žádosti. |
| Datum_spuštění | řetězec | Odpovídá začátku časového rozsahu použitého při odesílání volání. |
| Enddate | řetězec | Odpovídá konci časového rozsahu použitého při odesílání volání. |
ReportUrl je adresa URL, kterou lze použít pro další volání dotazování (operace GET). Když se pole stavu v odpovědi na dotazovací požadavek vrátí jako 3, žádost se dokončí. Pole blobPath v odpovědi máme vyplněné adresou URL odkazující na data csv. Objekt blob je k dispozici 1 den od data a času v poli odpovědi requestedOn. Stav 4, 5 a 7 je stav selhání, kdy volání rozhraní API dosáhlo chybového stavu. U všech ostatních stavů by se mělo dotazování opakovat.
Formát JSON
Níže uvedené rozhraní API poskytuje data ve formátu JSON. Pokud není zadané fakturační období, vrátí se data pro aktuální fakturační období. Maximální podporovaný časový rozsah je 36 měsíců.
| Metoda | Identifikátor URI žádosti |
|---|---|
| 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 |
Poznámka
Pokud chcete použít předchozí verzi rozhraní API, nahraďte ve výše uvedených adresách URL v3 v2. Některá pole nejsou dostupná, pokud používáte verzi 2.
Odpověď
Vzhledem k potenciálně velkému objemu dat se sada výsledků stránkuje. Vlastnost nextLink, pokud je k dispozici, určuje odkaz na další stránku dat. Pokud je odkaz prázdný, znamená to, že je poslední stránka.
{
"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"
}
Definice polí s podrobnostmi o využití
| Název vlastnosti | Typ | Description |
|---|---|---|
| id | řetězec | Jedinečné ID volání rozhraní API |
| data | Pole JSON | Pole podrobností o denním využití pro každou instanci\měřič. |
| nextLink | řetězec | Pokud existuje více stránek dat, odkaz nextLink odkazuje na adresu URL, aby se vrátila další stránka dat. |
| accountId | int | Zastaralé pole Je k dispozici pro zpětnou kompatibilitu. |
| productId | int | Zastaralé pole Je k dispozici pro zpětnou kompatibilitu. |
| resourceLocationId | int | Zastaralé pole Je k dispozici pro zpětnou kompatibilitu. |
| consumedServiceId | int | Zastaralé pole Je k dispozici pro zpětnou kompatibilitu. |
| departmentId | int | Zastaralé pole Je k dispozici pro zpětnou kompatibilitu. |
| accountOwnerEmail | řetězec | Email účet vlastníka účtu. |
| accountName | řetězec | Zákazník zadal název účtu. |
| serviceAdministratorId | řetězec | Email adresa správce služeb. |
| subscriptionId | int | Zastaralé pole Je k dispozici pro zpětnou kompatibilitu. |
| subscriptionGuid | řetězec | Globální jedinečný identifikátor předplatného. |
| subscriptionName | řetězec | Název předplatného. |
| date | řetězec | Datum, kdy došlo ke spotřebě. |
| product | řetězec | Další podrobnosti o měřiči. |
| meterId | řetězec | Identifikátor měřiče, který vygeneruje využití. |
| meterCategory | řetězec | Služba platformy Azure, která se použila. |
| meterSubCategory | řetězec | Definuje typ služby Azure, který může ovlivnit rychlost. |
| meterRegion | řetězec | Určuje polohu datového centra. U některých služeb vycházejí ceny z umístění datového centra. |
| meterName | řetězec | Název měřiče. |
| consumedQuantity | double | Množství spotřebovaného měřiče. |
| resourceRate | double | Sazba použitelná na fakturovatelnou jednotku. |
| cost | double | Poplatek účtovaný za měřič. |
| resourceLocation | řetězec | Identifikuje datacentrum, ve kterém je měřič spuštěný. |
| consumedService | řetězec | Služba platformy Azure, která se použila. |
| instanceId | řetězec | Tento identifikátor je název prostředku nebo plně kvalifikované ID prostředku. Další informace najdete v tématu Azure Resource Manager API. |
| serviceInfo1 | řetězec | Interní metadata služby Azure. |
| serviceInfo2 | řetězec | Například typ image u virtuálního počítače nebo název poskytovatele internetové služby ExpressRoute. |
| additionalInfo | řetězec | Metadata konkrétních služeb. Například typ image u virtuálního počítače. |
| tags | řetězec | Zákazník přidal značky. Další informace najdete v článku o uspořádání prostředků Azure pomocí značek. |
| storeServiceIdentifier | řetězec | Tento sloupec se nepoužívá. Je k dispozici pro zpětnou kompatibilitu. |
| departmentName | řetězec | Název oddělení. |
| costCenter | řetězec | Nákladové středisko, ke kterému je využití přidružené. |
| unitOfMeasure | řetězec | Určuje jednotku, po které se služba účtuje. Příklad: GB, hodiny, 10 000 s. |
| resourceGroup | řetězec | Skupina prostředků, ve které je nasazený měřič spuštěný. Další informace najdete v článku Přehled Azure Resource Manageru. |
| chargesBilledSeparately | řetězec | Poplatky fakturované mimo peněžní závazek |
| location | řetězec | Umístění, kam byla služba nasazena. |
| offerId | řetězec | OfferId vůči službě. |
| partNumber | řetězec | Číslo skladové položky pro službu. |
| resourceGuid | řetězec | Identifikátor měřiče, který vygeneruje využití. |
| serviceTier | řetězec | Úroveň služby. |
| Název_služby | řetězec | Název služby. |
Omezování rychlosti
Aby bylo možné zajistit konzistentní prostředí napříč našimi zákazníky, jsou všechna rozhraní API pro využití omezená na úrovni registrace. Když dosáhnete limitu, obdržíte stavový kód HTTP 429 Příliš mnoho požadavků. Aktuální propustnost v intervalu 15 minut je následující:
| rozhraní API | Limit přenosové rychlosti |
|---|---|
| Další stránka | 1000 |
| Stáhnout | 50 |
| Anketa | 180 |
| Odeslat | 20 |