Szolgáltatói erőforrás-használati API
A szolgáltató kifejezés a szolgáltatásadminisztrátorra és a delegált szolgáltatókra vonatkozik. Az Azure Stack Hub-operátorok és a delegált szolgáltatók a szolgáltató használati API-ját használhatják a közvetlen bérlőik használatának megtekintéséhez. Az alábbi ábrán látható módon például a P0 meghívhatja a szolgáltatói API-t, hogy közvetlen használati adatokat kapjon a P1-en és a P2-n, a P1 pedig meghívhatja a P3 és a P4 használatával kapcsolatos használati információkat.
API-hívás referenciája
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.
Ez a használati API egy szolgáltatói API, ezért a hívónak tulajdonosi, közreműködői vagy olvasói szerepkört kell hozzárendelnie a szolgáltató előfizetéséhez.
Metódus | Kérés URI-ja |
---|---|
GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&subscriberId={sub1.1}&api-version=2015-06-01-preview&continuationToken={token-value} |
Argumentumok
Argumentum | Description |
---|---|
armendpoint |
Azure Resource Manager Azure Stack Hub-környezet végpontja. Az Azure Stack Hub konvenciója szerint az Azure Resource Manager végpont neve formátuma https://adminmanagement.{domain-name} . Például az Azure Stack Development Kit (ASDK) esetében, ha a tartománynév local.azurestack.external, akkor a Resource Manager végpont a https://adminmanagement.local.azurestack.external . |
subId |
A hívást kezdeményező felhasználó előfizetés-azonosítója. |
reportedStartTime |
A lekérdezés kezdési időpontja. A értéknek DateTime az egyezményes világidő (UTC) és az óra elején kell lennie, például 13:00-kor. 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 ki van szökve %3a , a plusz %2b pedig az URI-barát. |
reportedEndTime |
A lekérdezés befejezési időpontja. Az argumentumra reportedStartTime vonatkozó korlátozások is érvényesek. A érték reportedEndTime nem lehet sem a jövőben, sem az aktuális dátumban. Ha igen, az eredmény "A feldolgozás nem fejeződött be" értékre van állítva. |
aggregationGranularity |
Választható 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ásban. A napi beállítás az alapértelmezett beállítás. |
subscriberId |
Előfizetés azonosítója. A szűrt adatok lekéréséhez a szolgáltató közvetlen bérlőjének előfizetés-azonosítójára van szükség. Ha nincs megadva előfizetés-azonosító paraméter, a hívás a szolgáltató összes közvetlen bérlőjének használati adatait adja vissza. |
api-version |
A kéréshez használt protokoll verziója. Ez az érték a következőre van állítva: 2015-06-01-preview . |
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. A folyamat könyvjelzőjeként működik. Ha a token nem található, a rendszer a nap vagy az óra elejétől kéri le az adatokat a megadott részletesség alapján. |
Reagálás
GET
/subscriptions/sub1/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&subscriberId=sub1.1&api-version=1.0
{
"value": [
{
"id":
"/subscriptions/sub1.1/providers/Microsoft.Commerce.Admin/UsageAggregate/sub1.1-
meterID1",
"name": "sub1.1-meterID1",
"type": "Microsoft.Commerce.Admin/UsageAggregate",
"properties": {
"subscriptionId":"sub1.1",
"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
Argumentum | Description |
---|---|
id |
A használati összesítés egyedi azonosítója. |
name |
A használati összesítés neve. |
type |
Erőforrás-definíció. |
subscriptionId |
Az Azure Stack Hub-felhasználó előfizetés-azonosítója. |
usageStartTime |
Annak a használati gyűjtőnek az UTC-kezdési időpontja, amelyhez ez a használati összesítés tartozik. |
usageEndTime |
Annak a használati gyűjtőnek az UTC-befejezési időpontja, amelyhez ez a használati aggregátum tartozik. |
instanceData |
Kulcs-érték párok példány részletei (új formátumban):resourceUri : Teljes erőforrás-azonosító, amely tartalmazza az erőforráscsoportokat és a példány nevét. location : A szolgáltatás futtatásának régiója. 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óját vagy képtípusát. |
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 ). |
Használati adatok lekérése
PowerShell
A használati adatok létrehozásához rendelkeznie kell a rendszert futtató és aktívan használó erőforrásokkal; például egy aktív virtuális gép (VM) vagy egy bizonyos adatokat tartalmazó tárfiók. Ha nem tudja biztosan, hogy vannak-e az Azure Stack Hub Marketplace-en futó erőforrások, helyezzen üzembe egy virtuális gépet, és ellenőrizze a virtuális gép monitorozási paneljét, hogy biztosan fut-e. A használati adatok megtekintéséhez használja a következő PowerShell-parancsmagokat:
Konfigurálja az Azure Stack Hub felhasználót vagy az Azure Stack Hub operátor PowerShell-környezetét.
A használati adatok lekéréséhez hívja meg a Get-AzsSubscriberUsage PowerShell-parancsmagot:
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST API
A törölt előfizetések használati adatait a Microsoft.Commerce.Rendszergazda szolgáltatás meghívásával gyűjtheti.
Az aktív felhasználók számára törölt összes bérlői használat visszaadva
Metódus | Kérés URI-ja |
---|---|
GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Törölt vagy aktív bérlő használati adatainak visszaadása
Metódus | Kérés URI-ja |
---|---|
GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview |