Sdílet prostřednictvím

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

  • Č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 Prostředí Windows PowerShell Get-UsageAggregates 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 Identifikátor URI požadavku
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.
reportedStartTime 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 řídicí ISO 8601; Například 2015-06-16T18%3a53%3a11%2b00%3a00Z, kde dvojtečka utekla do %3a a plus je utekla na %2b, aby byl identifikátor URI přátelský.
reportedEndTime Koncový čas dotazu. Omezení, která platí pro reportStartTime , platí také pro tento parametr. Hodnota reportedEndTime nemůže být v budoucnu.
agregaceGranularity Volitelný parametr, který má dvě diskrétní potenciální hodnoty: denně a každou hodinu. Jak napovídá hodnota, jedna vrátí data v denní členitosti a druhá je hodinová 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í zprostředkovatele rozhraní API 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ě členitosti předané.

Response

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í
type Definice prostředku
subscriptionId Identifikátor předplatného uživatele Azure.
usageStartTime Čas zahájení UTC kontejneru využití, do kterého patří tato agregace využití.
usageEndTime Koncový čas UTC kontejneru využití, do kterého patří tato agregace využití.
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 určuje.
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