Udostępnij za pośrednictwem

Dokumentacja interfejsu API użycia zasobów przez dzierżawcę

  • Artykuł

Najemca może używać interfejsów API najemcy do wyświetlania własnych danych dotyczących użycia zasobów. Te interfejsy API są zgodne z interfejsami API do zarządzania użyciem platformy Azure.

Możesz użyć polecenia cmdlet programu Windows PowerShell Get-AzUsageAggregate, aby uzyskać dane użycia, tak jak w Azure.

Wywołanie interfejsu API

Żądanie

Żądanie pobiera szczegóły użycia żądanych subskrypcji i dla żądanego przedziału czasu. Brak treści żądania.

Metoda Żądanie 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 Opis
Armendpoint Punkt końcowy usługi Azure Resource Manager środowiska usługi Azure Stack Hub. Konwencja usługi Azure Stack Hub polega na tym, że nazwa punktu końcowego usługi Azure Resource Manager ma format https://management.{domain-name}. Na przykład w przypadku zestawu programistycznego nazwa domeny to local.azurestack.external, a punkt końcowy usługi Resource Manager jest https://management.local.azurestack.external.
subId Identyfikator subskrypcji użytkownika, który wykonuje wywołanie. Tego interfejsu API można używać tylko do wykonywania zapytań dotyczących użycia pojedynczej subskrypcji. Dostawcy mogą używać interfejsu API wykorzystania zasobów dostawcy do wykonywania zapytań dotyczących wykorzystania dla wszystkich najemców.
zgłoszonyCzasPoczątkowy Godzina rozpoczęcia zapytania. Wartość daty /godziny powinna być w formacie UTC i na początku godziny, na przykład 13:00. W przypadku agregacji dziennej ustaw tę wartość na północ UTC. Format jest zeskalowanym ISO 8601; na przykład 2015-06-16T18%3a53%3a11%2b00%3a00Z, gdzie dwukropek jest zeskalowany do %3a, a plus do %2b, aby ułatwić kompatybilność z URI.
zgłoszonyCzasZakończenia Godzina zakończenia zapytania. Ograniczenia, które mają zastosowanie do zgłaszanegoStartTime , mają również zastosowanie do tego parametru. Wartość dla reportedEndTime nie może odnosić się do przyszłości.
granularnośćAgregacji Opcjonalny parametr, który ma dwie odrębne wartości potencjalne: codziennie i co godzinę. Jak sugerują wartości, jeden zwraca dane z dzienną szczegółowością, a drugi z godzinową rozdzielczością. Opcja dzienna jest domyślna.
api-wersja Wersja protokołu używanego do wykonania tego żądania. Musisz użyć 2015-06-01-preview.
continuationToken Token pobrany z ostatniego wywołania API dostawcy danych o użyciu. Ten token jest wymagany, gdy odpowiedź jest większa niż 1000 wierszy. Działa jako zakładka postępu. Jeśli nie jest obecne, dane są pobierane od początku dnia lub godziny, na podstawie przekazanego poziomu szczegółowości.

Odpowiedź

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"

}
},

...

Szczegóły odpowiedzi

Parametr Opis
identyfikator Unikatowy identyfikator agregatu użycia.
nazwa Nazwa agregacji użycia.
typ Definicja zasobu.
identyfikator subskrypcji Identyfikator subskrypcji użytkownika platformy Azure.
czasRozpoczęciaUżytkowania Godzina rozpoczęcia UTC przedziału wykorzystania, do którego należy to zbiorcze użycie.
czas zakończenia użytkowania Godzina zakończenia UTC segmentu użycia, do którego należy ta agregacja użycia.
instanceData Kluczowo-wartościowe pary szczegółów instancji (w nowym formacie):
resourceUri: w pełni określony identyfikator zasobu, obejmujący grupy zasobów oraz nazwę instancji.
location: region, w którym została uruchomiona ta usługa.
tagi: tagi zasobów określone przez użytkownika.
additionalInfo: Więcej szczegółów na temat używanego zasobu. Na przykład wersja systemu operacyjnego lub typ obrazu.
ilość Ilość zużycia zasobów, które wystąpiły w tym przedziale czasu.
meterId Unikatowy identyfikator zasobu, który został użyty (nazywany również identyfikatorem ResourceID).

Następne kroki