Bérlői erőforrás-használati API-referencia

  • Cikk

A bérlők a bérlői API-k használatával tekinthetik meg a bérlő saját erőforrás-használati adatait. Ezek az API-k összhangban vannak az Azure használati API-ival.

A Get-UsageAggregates Windows PowerShell parancsmaggal ugyanúgy lekérheti a használati adatokat, mint az Azure-ban.

API-hívás

Kérés

A kérelem lekéri a kért előfizetések használati adatait és a kért időkeretet. Nincs kérelemtörzs.

Metódus Kérés URI-ja
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Paraméterek

Paraméter Leírás
Armendpoint Azure Resource Manager Azure Stack Hub-környezet végpontja. Az Azure Stack Hub konvenciója, hogy az Azure Resource Manager végpont neve formátuma https://management.{domain-name}. A fejlesztői készlet esetében például a tartománynév local.azurestack.external, majd a Resource Manager végpontja.https://management.local.azurestack.external
alazonosító A hívást kezdeményező felhasználó előfizetés-azonosítója. Ezt az API-t csak egyetlen előfizetés használatának lekérdezésére használhatja. A szolgáltatók a szolgáltatói erőforrás-használati API-val kérdezhetik le az összes bérlő használati adatait.
reportedStartTime A lekérdezés kezdési időpontja. A DateTime értékének UTC-ben és az óra elején kell lennie; például 13:00. Napi összesítés esetén állítsa ezt az értéket UTC éjfélre. A formátum feloldott ISO 8601; Például : 2015-06-16T18%3a53%3a11%2b00%3a00Z, ahol a kettőspont a következőre van feloldva: %3a, a plusz pedig %2b-ra van feloldva, hogy URI-barát legyen.
reportedEndTime A lekérdezés befejezési időpontja. A reportedStartTime-ra vonatkozó korlátozások erre a paraméterre is vonatkoznak. A reportedEndTime értéke nem lehet a jövőben.
aggregationGranularity Nem kötelező paraméter, amely két különálló lehetséges értékkel rendelkezik: naponta és óránként. Ahogy az értékek is sugallják, az egyik napi részletességgel adja vissza az adatokat, a másik pedig óránkénti felbontást. A napi beállítás az alapértelmezett beállítás.
api-verzió A kéréshez használt protokoll verziója. A 2015-06-01-preview verziót kell használnia.
continuationToken A használati API-szolgáltató utolsó hívásából lekért jogkivonat. Erre a jogkivonatra akkor van szükség, ha egy válasz 1000 sornál nagyobb. Ez a folyamat könyvjelzőjeként működik. Ha nem jelenik meg, a rendszer a nap vagy óra kezdetétől kéri le az adatokat a megadott részletesség alapján.

Reagálás

GET
/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&api-version=1.0

{
"value": [
{

"id":
"/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregate/sub1-meterID1",
"name": "sub1-meterID1",
"type": "Microsoft.Commerce/UsageAggregate",

"properties": {
"subscriptionId":"sub1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"

}
},

...

Válasz részletei

Paraméter Leírás
id A használati összesítés egyedi azonosítója.
name A használati összesítés neve.
típus Erőforrás-definíció.
subscriptionId Az Azure-felhasználó előfizetés-azonosítója.
usageStartTime ANNAK a használati gyűjtőnek az UTC kezdő időpontja, amelyhez ez a használati aggregátum tartozik.
usageEndTime Annak a használati gyűjtőnek az UTC-befejezési időpontja, amelyhez ez a használati összesítés tartozik.
instanceData A példány részleteinek kulcs-érték párjai (új formátumban):
resourceUri: Teljes erőforrás-azonosító, beleértve az erőforráscsoportokat és a példány nevét.
location: Az a régió, ahol a szolgáltatást futtatták.
tags: A felhasználó által megadott erőforráscímkék.
additionalInfo: További részletek a felhasznált erőforrásról. Például az operációs rendszer verziója vagy a rendszerkép típusa.
quantity Az ebben az időkeretben bekövetkezett erőforrás-használat mennyisége.
meterId A felhasznált erőforrás egyedi azonosítója (más néven ResourceID).

Következő lépések