Nagyvállalati ügyfeleknek elérhető jelentéskészítési API-k – Használati adatok
Megjegyzés
2024. május 1-jén kivezetjük az Azure Enterprise Reporting API-kat. A fennmaradó Vállalati jelentéskészítési API-k nem válaszolnak a kérésekre. Az ügyfeleknek előbb át kell váltaniuk a Microsoft Cost Management API-k használatára. További tudnivalókért lásd: Migrálás az Azure Nagyvállalati jelentéskészítőből a Microsoft Cost Management API-kra – áttekintés.
Ez az API csak az adott erőforráshoz legfeljebb 400 címkekarakterekből rendelkező használati rekordokat támogat. Az API meghibásodhat, ha a rekordok meghaladják a címkék maximális számát. Ha ezt a problémát tapasztalja, migráljon az Exports vagy az Exports API helyre.
A Usage Details API a felhasznált mennyiségek napi részletezését és az adott regisztrációhoz kapcsolódó becsült költségeket jeleníti meg. Az eredmény a példányokkal, mérőszámokkal és részlegekkel kapcsolatos információkat is tartalmaz. Az API lekérdezhető számlázási időszak vagy egy megadott kezdő és záró dátum alapján.
A hozzáadandó általános címsortulajdonságokat a nagyvállalati ügyfeleknek készült jelentéskészítő API-k áttekintése tartalmazza. Egyéni időtartományok yyyy-MM-dd formátumú kezdő és záró dátum paraméterekkel adhatók meg.
CSV-formátum
Az alább felsorolt API CSV formátumban biztosítja az adatokat.
Szinkron hívás (nem lekérdezés)
A REST API-hívás válaszaként CSV formátumban adunk vissza adatokat. Az API teljesítménye a hívás által visszaadott használati adatok mennyiségétől függ, és legfeljebb 60 percet vehet igénybe. Annak ellenére, hogy az API támogatja az egyéni dátumtartományokat, javasoljuk, hogy korlátozza azt az adott időszakra vonatkozó használati adatok mennyisége alapján. Legfeljebb egy hónapos támogatást engedélyezünk.
| Metódus | Kérelem URI-nak letöltése |
|---|---|
| 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 |
Aszinkron hívás (lekérdezésalapú)
A hívás egy kétlépéses folyamat, amelynek során először be kell küldenie a kérést egy adott időtartományra, majd le kell kérnie egy megosztott hozzáférési kulcson alapuló URL-címet egy CSV-adatokat tartalmazó Azure Blob-helyhez. A maximálisan támogatott idő itt 36 hónap. Ezt az API-t nagyobb adathalmazokhoz ajánljuk.
| Metódus | Kérelem URI-ja elküldése |
|---|---|
| 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 |
Aszinkron (lekérdezési) hívás elküldésének válasza
{
"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"
}
Aszinkron hívás Válasz tulajdonságdefiníciói
| Tulajdonság neve | Típus | Description |
|---|---|---|
| id | sztring | A kérelem egyedi azonosítója. |
| enrollmentNumber | sztring | A kérelemhez tartozó regisztrációs szám. |
| requestedOn | sztring | A kérés dátumának időpontja. |
| status | int | A kérés állapotát jelzi. Queued = 1, InProgress = 2, Completed = 3, Failed = 4, NoDataFound = 5, ReadyToDownload=6, TimedOut = 7. |
| blobPath | sztring | A megosztott hozzáférési kulcs URL-címe a csv-blobhoz. |
| reportUrl | sztring | A kérelem elküldésének állapotának lekérdezéséhez használható URL-cím. |
| startDate | sztring | A küldési hívás során használt időtartomány elejének felel meg. |
| endDate | sztring | A küldési hívás során használt időtartomány végének felel meg. |
A reportUrl a további lekérdezési hívásokhoz (GET művelet) használható URL-cím. Amikor a lekérdezési kérelem válaszában szereplő állapotmező 3-asként tér vissza, a kérés befejeződik. A válaszban található blobPath mező a csv-adatokra mutató URL-címmel van feltöltve. A blob a requestedOn válaszmező dátumától számított 1 napig érhető el. A 4., 5. és 7. állapot olyan hibaállapot, amelyben az API-hívás hibafeltételt eredményezett. Minden más állapot esetén a lekérdezési hívást meg kell ismételni.
JSON formátum
Az alább felsorolt API JSON formátumban adja meg az adatokat. Ha nincs megadva számlázási időszak, a rendszer az aktuális számlázási időszakra vonatkozó adatokat adja vissza. A maximálisan támogatott időtartam 36 hónap.
| Metódus | Kérés URI-ja |
|---|---|
| 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 |
Megjegyzés
Az API előző verziójának használatához cserélje le a v3-at a fenti URL-címeken lévő v2-re. Egyes mezők nem érhetők el, ha v2-t használ.
Reagálás
A potenciálisan nagy mennyiségű adat miatt az eredményhalmaz lapozott. Ha a nextLink tulajdonság jelen van, a következő adatoldal hivatkozását adja meg. Ha a hivatkozás üres, az azt jelzi, hogy ez az utolsó oldal.
{
"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"
}
Használati adatok meződefiníciói
| Tulajdonság neve | Típus | Description |
|---|---|---|
| id | sztring | Az API-hívás egyedi azonosítója. |
| adatok | JSON-tömb | Az összes példány napi használati adatainak tömbje\mérő. |
| nextLink | sztring | Ha több oldalnyi adat található, a nextLink az URL-címre mutat a következő adatoldal visszaadásához. |
| accountId | int | Elavult mező. A visszamenőleges kompatibilitás érdekében jelen van. |
| productId | int | Elavult mező. A visszamenőleges kompatibilitás érdekében jelen van. |
| resourceLocationId | int | Elavult mező. A visszamenőleges kompatibilitás érdekében jelen van. |
| consumedServiceId | int | Elavult mező. A visszamenőleges kompatibilitás érdekében jelen van. |
| departmentId | int | Elavult mező. A visszamenőleges kompatibilitás érdekében jelen van. |
| accountOwnerEmail | sztring | Email fióktulajdonos fiókját. |
| accountName | sztring | Az ügyfél megadta a fiók nevét. |
| serviceAdministratorId | sztring | Email szolgáltatásadminisztrátor címe. |
| subscriptionId | int | Elavult mező. A visszamenőleges kompatibilitás érdekében jelen van. |
| subscriptionGuid | sztring | Az előfizetés globális egyedi azonosítója. |
| subscriptionName | sztring | Az előfizetés neve. |
| dátum | sztring | A fogyasztás bekövetkezésének dátuma. |
| product | sztring | További részletek a mérőről. |
| meterId | sztring | A használatot kibocsátó mérő azonosítója. |
| meterCategory | sztring | A használt Azure platformszolgáltatás. |
| meterSubCategory | sztring | Meghatározza azt az Azure-szolgáltatástípust, amely hatással lehet a sebességre. |
| meterRegion | sztring | Az igénybe vett vagy üzemeltető adatközpont elhelyezkedése, ha a szolgáltatás díjszabása az adatközpontok elhelyezkedésétől is függ. |
| meterName | sztring | A fogyasztásmérő neve. |
| consumedQuantity | double | A felhasznált fogyasztásmérő mennyisége. |
| resourceRate | double | A számlázható egységenként alkalmazandó díj. |
| cost | double | A fogyasztásmérőért felszámított díj. |
| resourceLocation | sztring | Azonosítja azt az adatközpontot, ahol a fogyasztásmérő fut. |
| consumedService | sztring | A használt Azure platformszolgáltatás. |
| instanceId | sztring | Ez az azonosító az erőforrás neve vagy a teljes erőforrás-azonosító. További információ: Azure Resource Manager API |
| serviceInfo1 | sztring | Belső Azure-szolgáltatás metaadatai. |
| serviceInfo2 | sztring | Például egy virtuális gép rendszerképének típusa vagy az ExpressRoute-hoz tartozó ISP-név. |
| additionalInfo | sztring | Szolgáltatásspecifikus metaadatok. Például egy virtuális gép rendszerképének típusa. |
| tags | sztring | Az ügyfél címkéket adott hozzá. További információkért lásd: Az Azure-erőforrások rendszerezése címkék használatával. |
| storeServiceIdentifier | sztring | Ez az oszlop nem használatos. A visszamenőleges kompatibilitás érdekében jelen van. |
| departmentName | sztring | A részleg neve. |
| costCenter | sztring | Az a költséghely, amelyhez a használat társítva van. |
| unitOfMeasure | sztring | A szolgáltatás számlázási egységét jelöli. Példa: GB, óra, 10 000 s. |
| resourceGroup | sztring | Az az erőforráscsoport, amelyben az üzembe helyezett mérő fut. További információt Az Azure Resource Manager áttekintésében találhat. |
| chargesBilledSeparately | sztring | A pénzügyi kereten kívül számlázott díjak. |
| location | sztring | A szolgáltatás üzembe helyezésének helye. |
| offerId | sztring | OfferId a szolgáltatáson. |
| partNumber | sztring | A szolgáltatás termékváltozatának száma. |
| resourceGuid | sztring | A használatot kibocsátó mérő azonosítója. |
| serviceTier | sztring | Szolgáltatási szint. |
| serviceName | sztring | Szolgáltatásnév. |
Sebességkorlátozás
Az ügyfelek egységes felhasználói élményének biztosítása érdekében az összes használati API-ra korlátozott a regisztrációs szint. Amikor eléri a korlátot, a HTTP-állapotkód 429 Túl sok kérést kap. Az aktuális átviteli sebesség 15 perces intervallumban az alábbi:
| API | Sebességkorlát |
|---|---|
| Nextpage | 1000 |
| Letöltés | 50 |
| Szavazás | 180 |
| Küldés | 20 |