Sdílet prostřednictvím

Referenční informace k rozhraní API pro využití prostředků tenanta

  • Článek

Tenant může pomocí rozhraní API tenanta zobrazit vlastní data o využití prostředků tenanta. Tato rozhraní API jsou konzistentní s rozhraními API pro využití Azure.

K získání dat o využití můžete použít rutinu Windows PowerShell Get-UsageAggregates, stejně jako v Azure.

Volání rozhraní API

Žádost

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

Metoda Identifikátor URI žádosti
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
Koncový bod Azure Resource Manager koncový bod prostředí služby Azure Stack Hub. Konvence služby Azure Stack Hub je, že název koncového bodu Azure Resource Manager 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 Manager je https://management.local.azurestack.external.
id předplatného ID předplatného uživatele, který provádí volání. Toto rozhraní API můžete použít pouze k dotazování na využití jednoho předplatného. Poskytovatelé můžou použít rozhraní API pro využití prostředků poskytovatele k dotazování na využití pro všechny tenanty.
reportedStartTime Čas zahájení dotazu. Hodnota pro 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 v UTC. Formát je řídicí ISO 8601; Například 2015-06-16T18%3a53%3a11%2b00%3a00Z, kde dvojtečka je uchycená na %3a a plus je uchycená na %2b, takže je vhodný pro identifikátor URI.
reportedEndTime Čas ukončení dotazu. Omezení, která platí pro reportStartTime platí také pro tento parametr. Hodnota reportedEndTime nemůže být v budoucnu.
aggregationGranularity Volitelný parametr, který má dvě diskrétní potenciální hodnoty: denní a hodinovou. Jak hodnoty naznačují, jeden vrací data v denním intervalu a druhý je hodinové rozlišení. Denní možnost je výchozí.
verze-api Verze protokolu, který se používá k provedení tohoto požadavku. Musíte použít verzi 2015-06-01-preview.
continuationToken Token načtený z posledního volání zprostředkovatele rozhraní API pro využití. Tento token je potřeba, pokud je odpověď větší než 1 000 řádků. Funguje jako záložka pro průběh. Pokud nejsou k dispozici, data se načtou od začátku dne nebo hodiny na základě předané členitosti.

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
id Jedinečné ID agregace využití
name Název agregace využití.
typ Definice prostředku.
subscriptionId Identifikátor předplatného uživatele Azure.
usageStartTime Počáteční čas UTC kbelíku využití, do kterého tato agregace využití patří.
usageEndTime Koncový čas UTC kbelíku využití, do kterého tato agregace využití patří.
instanceData Páry klíč-hodnota podrobností instance (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 prostředků, které uživatel zadá.
additionalInfo: Další podrobnosti o spotřebovaném prostředku. Například verze operačního systému nebo typ image.
quantity Objem spotřeby prostředků, ke kterému došlo v tomto časovém rámci.
meterId Jedinečné ID spotřebovaného prostředku (označuje se také jako ID prostředku).

Další kroky