Referenční informace k rozhraní API využití prostředků tenanta
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 Windows PowerShell můžete použít rutinu Get-UsageAggregates stejně jako v Azure.
Volání rozhraní API
Žádost
Požadavek získá podrobnosti o spotřebě pro požadovaná předplatná a pro požadovaný časový rámec. Neexistuje žádný text požadavku.
| Metoda | Identifikátor URI žádosti |
|---|---|
| GET | https://{armendpoint}/subscriptions/{id_předplatného}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-previewcontinuationToken&={token-value} |
Parametry
| Parametr | Popis |
|---|---|
| Armendpoint (Armendpoint) | Azure Resource Manager koncového bodu vašeho Azure Stack Hub prostředí. Konvence Azure Stack Hub je, že název koncového 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ý Resource Manager je https://management.local.azurestack.external. |
| id_podadresy | ID předplatného uživatele, který volá. Toto rozhraní API můžete použít pouze k dotazování na využití jednoho předplatného. Poskytovatelé mohou pomocí rozhraní API využití prostředků poskytovatele dotazovat využití pro všechny tenanty. |
| reportedStartTime | Počáteční čas dotazu. Hodnota DateTime by měla být ve standardu UTC a na začátku hodiny. Například 13:00. Pro denní agregaci nastavte tuto hodnotu na půlnoc v UTC. Formát je uvozena uvozovacími znaky ISO 8601. Například 2015-06-16T18%3a53%3a11%2b00%3a00Z, kde dvojtečka je uvozena na %3a a plus je uvozena na %2b, aby byl identifikátor URI popisný. |
| reportedEndTime | Koncový čas dotazu. Omezení, která platí pro reportedStartTime , platí také pro tento parametr. Hodnota reportedEndTime nemůže být v budoucnu. |
| aggregation (agregační číslo) | Volitelný parametr, který má dvě diskrétní potenciální hodnoty: denněa každou hodinu. Jak hodnoty naznačují, jedna vrací data v denních členitostech 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. |
| token pokračování | Token načtený z posledního volání zprostředkovatele rozhraní API pro využití. Tento token je potřeba, když je odpověď větší než 1 000 řádků. Funguje jako záložka pro průběh. Pokud není k dispozici, data se načítá 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 pro kbelík využití, do kterého tato agregace využití patří. |
| usageEndTime | Koncový čas UTC pro kbelík 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. location: Oblast, ve které byla tato služba spuštěna. tags: Značky prostředků, které uživatel určí. additionalInfo: Další podrobnosti o spotřebovaném prostředku. Například verze operačního systému nebo typ image. |
| quantity | 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 (také nazývaného ResourceID). |