Sdílet prostřednictvím

Referenční informace k API pro využití prostředků nájemce

  • Článek

Tenant může použít rozhraní API tenanta k zobrazení vlastních dat o využití prostředků tenanta. Tato rozhraní API jsou konzistentní s rozhraními API využití Azure.

Pomocí rutiny Windows PowerShellu Get-AzUsageAggregate můžete získat data o využití stejně jako v Azure.

Volání rozhraní API

Žádost

Žádost získá podrobnosti o spotřebě požadovaných předplatných a pro požadovaný časový rámec. Neexistuje žádný text požadavku.

Metoda Požadavek URI
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parametry

Parametr Popis
Armendpoint Koncový bod Azure Resource Manageru vašeho prostředí služby Azure Stack Hub. Konvence služby Azure Stack Hub je, že název koncového bodu Azure Resource Manageru je ve formátu https://management.{domain-name}. Například pro vývojovou sadu je název domény local.azurestack.external a koncový bod Resource Manageru je https://management.local.azurestack.external.
subId ID předplatného uživatele, který hovor provádí. Toto rozhraní API můžete použít pouze k dotazování na využití jednoho předplatného. Poskytovatelé můžou k dotazování na využití všech tenantů použít rozhraní API využití prostředků poskytovatele.
nahlášený čas začátku Počáteční čas dotazu. Hodnota dateTime by měla být v UTC a na začátku hodiny, například 13:00. Pro denní agregaci nastavte tuto hodnotu na půlnoc UTC. Formát je zakódovaný podle ISO 8601; například 2015-06-16T18%3a53%3a11%2b00%3a00Z, kde dvojtečka je zakódována jako %3a a plus jako %2b, aby byl vhodný pro URI.
nahlášenýČasKonce Koncový čas dotazu. Omezení, která platí pro reportStartTime , platí také pro tento parametr. Hodnota reportedEndTime nemůže být v čase budoucím.
agregační granularita Volitelný parametr, který má dvě diskrétní potenciální hodnoty: denně a každou hodinu. Jak napovídají hodnoty, jedna vrací data v denním rozlišení a druhá v hodinovém rozlišení. Výchozí možností je denní možnost.
verze API Verze protokolu, který se používá k provedení tohoto požadavku. Musíte použít verzi 2015-06-01-preview.
pokračováníToken Token načtený z posledního volání poskytovatele API využití Tento token je potřeba, pokud je odpověď větší než 1 000 řádků. Funguje jako záložka sledující pokrok. Pokud data nejsou k dispozici, načtou se od začátku dne nebo hodiny podle zadané granularizace.

Odpověď

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"

}
},

...

Podrobnosti odpovědi

Parametr Popis
identifikátor Jedinečné ID souhrnu využití
jméno Název agregace využití
typ Definice prostředku
ID předplatného Identifikátor předplatného uživatele Azure.
čas zahájení používání Čas zahájení UTC objemu využití, do kterého patří tato agregace využití.
čas ukončení používání Koncový čas UTC kontejneru využití, do kterého patří tato agregace využití.
instanceData Podrobnosti instance ve formě párů klíč-hodnota (v novém formátu):
resourceUri: Plně kvalifikované ID prostředku, včetně skupin prostředků a názvu instance.
umístění: Oblast, ve které byla tato služba spuštěna.
tags: Značky zdrojů, které uživatel určí.
additionalInfo: Další podrobnosti o spotřebovaném prostředku. Například verze operačního systému nebo typ image.
množství. Množství spotřeby prostředků, ke kterým došlo v tomto časovém rámci.
meterId Jedinečné ID spotřebovaného prostředku (označovaného také jako ResourceID)

Další kroky