Udostępnij za pośrednictwem

Dokumentacja interfejsu API użycia zasobów dzierżawy

  • Artykuł

Dzierżawa może używać interfejsów API dzierżawy do wyświetlania własnych danych użycia zasobów dzierżawy. Te interfejsy API są spójne z interfejsami API użycia platformy Azure.

Aby uzyskać dane użycia, podobnie jak na platformie Azure, możesz użyć polecenia cmdlet Windows PowerShell Get-UsageAggregates.

Wywołanie interfejsu API

Żądanie

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

Metoda Identyfikator URI żądania
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&agregacjaGranularity={granularity}&api-version=2015-06-01-preview&kontynuacjaToken={token-value}

Parametry

Parametr Opis
Punkt końcowy armend 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 deweloperów nazwa domeny to local.azurestack.external, a następnie Resource Manager punkt końcowy to https://management.local.azurestack.external.
subId Identyfikator subskrypcji użytkownika, który wykonuje połączenie. Tego interfejsu API można używać tylko do wykonywania zapytań dotyczących użycia pojedynczej subskrypcji. Dostawcy mogą używać interfejsu API użycia zasobów dostawcy do wykonywania zapytań dotyczących użycia dla wszystkich dzierżaw.
raportStartTime 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 ucieczki ISO 8601; na przykład 2015-06-16T18%3a53%3a11%2b00%3a00Z, gdzie dwukropek jest ucieczki do %3a i plus jest ucieczki do %2b, aby był przyjazny dla identyfikatora URI.
reportedEndTime Godzina zakończenia zapytania. Ograniczenia, które mają zastosowanie do zgłaszanegostarttime , mają również zastosowanie do tego parametru. Wartość zgłaszaneEndTime nie może być w przyszłości.
agregacjaGranularity Opcjonalny parametr, który ma dwie dyskretne potencjalne wartości: codziennie i co godzinę. Jak sugerują wartości, jeden zwraca dane w dziennym stopnia szczegółowości, a drugi jest godzinowym rozwiązaniem. Opcja dzienna jest domyślna.
api-version Wersja protokołu używanego do wykonania tego żądania. Musisz użyć wersji zapoznawczej 2015-06-01.
continuationToken Token pobrany z ostatniego wywołania dostawcy interfejsu API użycia. Ten token jest wymagany, gdy odpowiedź jest większa niż 1000 wierszy. Działa jako zakładka postępu. Jeśli dane nie są obecne, są pobierane od początku dnia lub godziny na podstawie stopnia szczegółowości przekazanego.

Reakcja

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 agregacji użycia.
name Nazwa agregacji użycia.
typ Definicja zasobu.
subscriptionId Identyfikator subskrypcji użytkownika platformy Azure.
usageStartTime Godzina rozpoczęcia utc zasobnika użycia, do którego należy ta agregacja użycia.
usageEndTime Godzina zakończenia czasu UTC zasobnika użycia, do którego należy ta agregacja użycia.
Instancedata Pary klucz-wartość szczegółów wystąpienia (w nowym formacie):
resourceUri: w pełni kwalifikowany identyfikator zasobu, w tym grupy zasobów i nazwa wystąpienia.
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 dotyczących używanego zasobu. Na przykład wersja systemu operacyjnego lub typ obrazu.
quantity Ilość uż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