Interfejsy API raportowania dla klientów korporacyjnych — szczegóły użycia
Uwaga
1 maja 2024 r. zostaną wycofane interfejsy API raportowania dla przedsiębiorstw platformy Azure. Wszystkie pozostałe interfejsy API raportowania przedsiębiorstwa przestaną odpowiadać na żądania. Klienci muszą przejść do korzystania z interfejsów API usługi Microsoft Cost Management przed upływem tego czasu. Aby dowiedzieć się więcej, zobacz Omówienie migracji z raportowania dla przedsiębiorstw na platformie Azure do interfejsów API usługi Microsoft Cost Management.
Ten interfejs API obsługuje tylko rekordy użycia z maksymalnie 400 znakami tagów dla danego zasobu. W tym interfejsie API może wystąpić niepowodzenie, jeśli masz rekordy przekraczające maksymalną liczbę tagów. Jeśli wystąpi ten problem, użyj funkcji eksportowania lub interfejsu API eksportowania.
Interfejs API szczegółów użycia podaje dzienny podział ilości wykorzystanych zasobów i szacowane opłaty według rejestracji. Wynik zawiera również informacje na temat wystąpień, liczników i działów. Do tego interfejsu API można wysyłać zapytania według okresu rozliczeniowego lub określonej daty rozpoczęcia i zakończenia.
Typowe właściwości nagłówka, które należy dodać, są określone w artykule Przegląd interfejsów API raportowania dla klientów korporacyjnych. Niestandardowe zakresy czasu można określić za pomocą parametrów daty rozpoczęcia i zakończenia, które są w formacie rrrr-MM-dd.
CSV Format
Interfejs API wymieniony poniżej udostępnia dane w formacie CSV.
Wywołanie synchroniczne (bez sondowania)
Zwracamy dane w formacie CSV jako odpowiedź wywołania interfejsu API REST. Wydajność interfejsu API zależy od ilości danych użycia zwracanych przez wywołanie i może potrwać maksymalnie 60 minut. Mimo że interfejs API obsługuje niestandardowe zakresy dat, zalecamy ograniczenie go na podstawie ilości danych użycia, które są dostępne w tym okresie. Zezwalamy na obsługę maksymalnie jednego miesiąca.
| Metoda | Identyfikator URI żądania pobierania |
|---|---|
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/download?billingPeriod={billingPeriod} |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/download?startTime=2017-01-01& endTime=2017-01-10 |
Wywołanie asynchroniczne (oparte na sondowaniu)
Wywołanie to dwuetapowy proces, który wymaga uprzedniego przesłania żądania dla określonego zakresu czasu, a następnie sondowania w celu uzyskania adresu URL opartego na kluczu dostępu współdzielonego dla lokalizacji obiektu blob platformy Azure zawierającej dane CSV. Maksymalny obsługiwany czas wynosi 36 miesięcy. Zalecamy ten interfejs API dla większych zestawów danych.
| Metoda | Prześlij identyfikator URI żądania |
|---|---|
| POST | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/submit?billingPeriod={billingPeriod} |
| POST | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/submit?startTime=2017-04-01& endTime=2017-04-10 |
Odpowiedź na żądanie przesyłania asynchronicznego (sondowania)
{
"id": "string",
"enrollmentNumber":"string",
"requestedOn":"2017-08-29T06:56:29.1290704Z",
"status":1,
"blobPath":"",
"reportUrl":"string",
"startDate":"2017-06-01T00:00:00",
"endDate":"2017-06-30T00:00:00"
}
Definicje właściwości wywołania asynchronicznego wywołania odpowiedzi
| Nazwa właściwości | Typ | Opis |
|---|---|---|
| identyfikator | ciąg | Unikatowy identyfikator żądania. |
| enrollmentNumber | ciąg | Numer rejestracji, dla którego zostało wykonane żądanie. |
| requestedOn | ciąg | Data wykonania żądania. |
| status | int | Wskazuje stan żądania. Queued = 1, InProgress = 2, Completed = 3, Failed = 4, NoDataFound = 5, ReadyToDownload=6, TimedOut = 7. |
| BlobPath | ciąg | Adres URL klucza dostępu współdzielonego do obiektu blob csv. |
| Reporturl | ciąg | Adres URL, który może służyć do sondowania stanu żądania przesyłania. |
| Startdate | ciąg | Odpowiada początku zakresu czasu używanego podczas przesyłania wywołania. |
| Enddate | ciąg | Odpowiada końcu zakresu czasu używanego podczas przesyłania wywołania. |
ReportUrl to adres URL, który może służyć do dalszych wywołań sondowania (operacja GET). Gdy pole stanu w odpowiedzi na żądanie sondowania zostanie przywrócone jako 3, żądanie zostanie ukończone. Mamy pole blobPath w odpowiedzi wypełnione adresem URL wskazującym dane csv. Obiekt blob jest dostępny przez 1 dzień od godziny daty w żądanym polu odpowiedzi. Stan 4, 5 i 7 to stan niepowodzenia, w którym wywołanie interfejsu API osiągnęło warunek błędu. W przypadku wszystkich innych stanów należy powtórzyć wywołanie sondowania.
JSON Format
Interfejs API wymieniony poniżej udostępnia dane w formacie JSON. Jeśli nie określono okresu rozliczeniowego, zwracane są dane dla bieżącego okresu rozliczeniowego. Maksymalny obsługiwany zakres czasu wynosi 36 miesięcy.
| Metoda | Identyfikator URI żądania |
|---|---|
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/usagedetails |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetailsbycustomdate?startTime=2017-01-01& endTime=2017-01-10 |
Uwaga
Aby użyć poprzedniej wersji interfejsu API, zastąp ciąg v3 wartością v2 w powyższych adresach URL. Niektóre pola nie są dostępne, jeśli używasz wersji 2.
Reakcja
Ze względu na potencjalnie dużą ilość danych zestaw wyników jest stronicowany. Właściwość nextLink, jeśli jest obecna, określa link do następnej strony danych. Jeśli link jest pusty, oznacza to, że jest to ostatnia strona.
{
"id": "string",
"data": [
{
"serviceName":"Storage",
"serviceTier":"Premium Page Blobs",
"location":"US West",
"chargesBilledSeparately":false,
"partNumber":"ABC-12345",
"resourceGuid":"00000000-0000-0000-0000-000000000000",
"offerId":"MS-AZR-0003P",
"cost":1,
"accountId":123456,
"productId":1234,
"resourceLocationId":12,
"consumedServiceId":1,
"departmentId":3456,
"accountOwnerEmail":"account@live.com",
"accountName":"Account Name",
"serviceAdministratorId":"123",
"subscriptionId":0000000,
"subscriptionGuid":"00000000-0000-0000-0000-000000000000",
"subscriptionName":"Subscription Name",
"date":"2018-08-01T00:00:00",
"product":"Locally Redundant Storage Premium Storage - Page Blob/P10 - US West",
"meterId":"00000000-0000-0000-0000-000000000000",
"meterCategory":"Storage",
"meterSubCategory":"Locally Redundant",
"meterRegion":"California",
"meterName":"Premium Storage - Page Blob/P10 (Units)",
"consumedQuantity"1,
"resourceRate":1,
"resourceLocation":"uswest",
"consumedService":"Microsoft.Compute",
"instanceId":"Id",
"serviceInfo1":"string",
"serviceInfo2":"string",
"additionalInfo":"string",
"tags":"string",
"storeServiceIdentifier":"string",
"departmentName":"Department Name",
"costCenter":"1234",
"unitOfMeasure":"Units",
"resourceGroup":"ResourceGroup"
}
],
"nextLink": "string"
}
Definicje pól szczegółów użycia
| Nazwa właściwości | Typ | Opis |
|---|---|---|
| identyfikator | ciąg | Unikatowy identyfikator wywołania interfejsu API. |
| dane | Tablica JSON | Tablica szczegółów dziennego użycia dla każdego wystąpienia\miernika. |
| nextLink | ciąg | Gdy istnieje więcej stron danych, następny link wskazuje adres URL, aby zwrócić następną stronę danych. |
| accountId | int | Przestarzałe pole. Obecny na potrzeby zgodności z poprzednimi wersjami. |
| productId | int | Przestarzałe pole. Obecny na potrzeby zgodności z poprzednimi wersjami. |
| resourceLocationId | int | Przestarzałe pole. Obecny na potrzeby zgodności z poprzednimi wersjami. |
| consumedServiceId | int | Przestarzałe pole. Obecny na potrzeby zgodności z poprzednimi wersjami. |
| departmentId | int | Przestarzałe pole. Obecny na potrzeby zgodności z poprzednimi wersjami. |
| accountOwnerEmail | ciąg | Email konto właściciela konta. |
| accountName | ciąg | Klient wprowadził nazwę konta. |
| serviceAdministratorId | ciąg | Email adres administratora usługi. |
| subscriptionId | int | Przestarzałe pole. Obecny na potrzeby zgodności z poprzednimi wersjami. |
| subscriptionGuid | ciąg | Globalny unikatowy identyfikator subskrypcji. |
| subscriptionName | ciąg | Nazwa subskrypcji. |
| data | ciąg | Data, w której wystąpiło zużycie. |
| product | ciąg | Dodatkowe szczegóły dotyczące miernika. |
| meterId | ciąg | Identyfikator miernika, który emitował użycie. |
| meterCategory | ciąg | Używana usługa platformy Azure. |
| meterSubCategory | ciąg | Definiuje typ usługi platformy Azure, który może mieć wpływ na szybkość. |
| meterRegion | ciąg | Określa lokalizację centrum danych pewnych usług, które są wyceniane na podstawie lokalizacji centrum danych. |
| meterName | ciąg | Nazwa miernika. |
| consumedQuantity | double | Ilość miernika, który został użyty. |
| resourceRate | double | Stawka dotyczy jednostki rozliczanej. |
| cost | double | Opłata, która została naliczona dla miernika. |
| resourceLocation | ciąg | Określa centrum danych, w którym działa miernik. |
| consumedService | ciąg | Używana usługa platformy Azure. |
| instanceId | ciąg | Ten identyfikator to nazwa zasobu lub w pełni kwalifikowany identyfikator zasobu. Aby uzyskać więcej informacji, zobacz Interfejs API usługi Azure Resource Manager |
| serviceInfo1 | ciąg | Wewnętrzne metadane usługi platformy Azure. |
| serviceInfo2 | ciąg | Na przykład typ obrazu dla maszyny wirtualnej i nazwa usługodawcy internetowego dla usługi ExpressRoute. |
| additionalInfo | ciąg | Metadane dotyczące konkretnej usługi. Na przykład typ obrazu dla maszyny wirtualnej. |
| tags | ciąg | Klient dodał tagi. Aby uzyskać więcej informacji, zobacz temat Organize your Azure resources with tags (Organizowanie zasobów platformy Azure za pomocą tagów). |
| storeServiceIdentifier | ciąg | Ta kolumna nie jest używana. Obecny na potrzeby zgodności z poprzednimi wersjami. |
| departmentName | ciąg | Nazwa działu. |
| costCenter | ciąg | Centrum kosztów skojarzone z użyciem. |
| unitOfMeasure | ciąg | Identyfikuje jednostkę, w której rozliczana jest usługa. Przykład: GB, godziny, 10 000 s. |
| resourceGroup | ciąg | Grupa zasobów, w której działa wdrożony miernik. Aby uzyskać więcej informacji, zobacz Omówienie usługi Azure Resource Manager. |
| chargesBilledSeparately | ciąg | Opłaty rozliczane poza zobowiązaniem pieniężnym. |
| location | ciąg | Lokalizacja, w której wdrożono usługę. |
| offerId | ciąg | OfferId względem usługi. |
| partNumber | ciąg | Numer jednostki SKU dla usługi. |
| resourceGuid | ciąg | Identyfikator miernika, który emitował użycie. |
| serviceTier | ciąg | Warstwa usługi. |
| Servicename | ciąg | Nazwa usługi. |
Ograniczanie szybkości
Aby umożliwić spójne środowisko dla naszych klientów, wszystkie interfejsy API użycia są ograniczone na poziomie rejestracji. Po osiągnięciu limitu otrzymasz kod stanu HTTP 429 Zbyt wiele żądań. Bieżąca przepływność w interwale 15 minut jest następująca:
| interfejs API | Limit szybkości |
|---|---|
| Nextpage | 1000 |
| Pobierz | 50 |
| Ankiety | 180 |
| Prześlij | 20 |