Api-referens för klientresursanvändning

  • Artikel

En klientorganisation kan använda klient-API:erna för att visa klientorganisationens egna resursanvändningsdata. Dessa API:er överensstämmer med Api:erna för Azure-användning.

Du kan använda Windows PowerShell-cmdleten Get-UsageAggregates för att hämta användningsdata, precis som i Azure.

API-anrop

Förfrågan

Begäran hämtar förbrukningsinformation för de begärda prenumerationerna och för den begärda tidsramen. Det finns inget begärandetext.

Metod URI för förfrågan
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parametrar

Parameter Beskrivning
Armendpoint Azure Resource Manager slutpunkt för din Azure Stack Hub-miljö. Azure Stack Hub-konventionen är att namnet på Azure Resource Manager slutpunkt är i formatet https://management.{domain-name}. För utvecklingspaketet är domännamnet till exempel local.azurestack.external och sedan är https://management.local.azurestack.externalden Resource Manager slutpunkten .
subId Prenumerations-ID för den användare som anropar. Du kan bara använda det här API:et för att fråga efter en enskild prenumerations användning. Leverantörer kan använda API:et för resursanvändning för providern för att fråga användning för alla klienter.
reportedStartTime Starttid för frågan. Värdet för DateTime ska vara i UTC och i början av timmen. till exempel 13:00. För daglig aggregering anger du det här värdet till UTC midnatt. Formatet är undantaget ISO 8601; Till exempel 2015-06-16T18%3a53%3a11%2b00%3a00Z, där kolonet är undantaget till %3a och plus är undantaget till %2b så att det är URI-vänligt.
reportedEndTime Sluttid för frågan. De begränsningar som gäller för reportedStartTime gäller även för den här parametern. Värdet för reportedEndTime kan inte vara i framtiden.
aggregeringGranularitet Valfri parameter som har två diskreta potentiella värden: dagligen och varje timme. Som värdena antyder returnerar en data i daglig kornighet, och den andra är en timmatchning. Det dagliga alternativet är standardalternativet.
api-version Version av protokollet som används för att göra den här begäran. Du måste använda 2015-06-01-preview.
continuationToken Token som hämtades från det senaste anropet till api-providern för användning. Den här token behövs när ett svar är större än 1 000 rader. Det fungerar som ett bokmärke för förlopp. Om de inte finns hämtas data från början av dagen eller timmen baserat på den kornighet som skickas in.

Svarsåtgärder

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"

}
},

...

Svarsinformation

Parameter Beskrivning
id Unikt ID för användningsaggregatet.
name Namnet på användningsmängden.
typ Resursdefinition.
subscriptionId Prenumerationsidentifierare för Azure-användaren.
usageStartTime UTC-starttiden för användningsbucketen som den här användningsmängden tillhör.
usageEndTime UTC-sluttiden för användningsbucketen som den här användningsmängden tillhör.
instanceData Nyckel/värde-par med instansinformation (i ett nytt format):
resourceUri: Fullständigt kvalificerat resurs-ID, inklusive resursgrupper och instansnamn.
plats: Region där den här tjänsten kördes.
taggar: Resurstaggar som användaren anger.
additionalInfo: Mer information om resursen som förbrukades. Till exempel operativsystemversion eller avbildningstyp.
quantity Mängden resursförbrukning som inträffade under den här tidsramen.
meterId Unikt ID för resursen som förbrukades (kallas även ResourceID).

Nästa steg