Generate Cost Details Report - Get Operation Results

Odwołanie

Usługa:: Cost Management

Wersja interfejsu API:: 2023-11-01

Pobierz wynik określonej operacji. Ten link znajduje się w nagłówku Lokalizacja odpowiedzi żądania tworzenia elementu CostDetails.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}?api-version=2023-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
operationId	path	True	string	Identyfikator operacji docelowej.
scope	path	True	string	Identyfikator zasobu usługi ARM dla subskrypcji, konta rozliczeniowego lub innych zakresów rozliczeniowych. Obecnie grupa zasobów i grupa zarządzania nie są obsługiwane. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/costmgmt/scopes.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CostDetailsOperationResults	OK. Żądanie zakończyło się pomyślnie.
202 Accepted		Akceptowane. Trwa operacja.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get details of the operation result

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}

Kod stanu:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60

Definicje

Nazwa	Opis
BlobInfo	Informacje o obiekcie blob wygenerowane przez tę operację.
CostDetailsDataFormat	Format danych raportu
CostDetailsMetricType	Typ szczegółowego raportu. Domyślnie jest udostępniany koszt rzeczywisty
CostDetailsOperationResults	Wynik długotrwałej operacji dla interfejsu API szczegółów kosztów.
CostDetailsStatusType	Stan operacji szczegółów kosztów
CostDetailsTimePeriod	Data rozpoczęcia i zakończenia ściągania danych dla szczegółowego raportu dotyczącego kosztów. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej i nie starsze niż 13 miesięcy.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie. Niektóre odpowiedzi na błędy: 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po odczekaniu czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.
GenerateCostDetailsReportRequestDefinition	Definicja szczegółowego raportu dotyczącego kosztów.

BlobInfo

Informacje o obiekcie blob wygenerowane przez tę operację.

Nazwa	Typ	Opis
blobLink	string	Połącz z obiektem blob, aby pobrać plik.
byteCount	integer	Bajty w obiekcie blob.

CostDetailsDataFormat

Format danych raportu

Nazwa	Typ	Opis
Csv	string	Format danych CSV.

CostDetailsMetricType

Typ szczegółowego raportu. Domyślnie jest udostępniany koszt rzeczywisty

Nazwa	Typ	Opis
ActualCost	string	Dane kosztów rzeczywistych.
AmortizedCost	string	Dane kosztów zamortyzowanych.

CostDetailsOperationResults

Wynik długotrwałej operacji dla interfejsu API szczegółów kosztów.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.
id	string	Identyfikator długotrwałej operacji.
manifest.blobCount	integer	Całkowita liczba obiektów blob.
manifest.blobs	BlobInfo[]	Lista informacji o obiektach blob wygenerowanych przez tę operację.
manifest.byteCount	integer	Całkowita liczba bajtów we wszystkich obiektach blob.
manifest.compressData	boolean	Czy dane są w formacie skompresowanym.
manifest.dataFormat	CostDetailsDataFormat	Format danych raportu
manifest.manifestVersion	string	Wersja manifestu.
manifest.requestContext.requestBody	GenerateCostDetailsReportRequestDefinition	Treść ładunku żądania podana w wywołaniu Cost Details
manifest.requestContext.requestScope	string	Zakres żądania.
name	string	Nazwa długotrwałej operacji.
status	CostDetailsStatusType	Stan operacji szczegółów kosztów
type	string	Typ długotrwałej operacji.
validTill	string	Czas, w którym adres URL raportu staje się nieprawidłowy/wygasa w formacie UTC, np. 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

Stan operacji szczegółów kosztów

Nazwa	Typ	Opis
Completed	string	Operacja jest zakończona.
Failed	string	Operacja nie powiodła się.
NoDataFound	string	Operacja jest ukończona i nie znaleziono danych kosztów.

CostDetailsTimePeriod

Data rozpoczęcia i zakończenia ściągania danych dla szczegółowego raportu dotyczącego kosztów. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej i nie starsze niż 13 miesięcy.

Nazwa	Typ	Opis
end	string	Data zakończenia do ściągnięcia danych. przykładowy format 2020-03-15
start	string	Data rozpoczęcia ściągania danych. przykładowy format 2020-03-15

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po odczekaniu czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

GenerateCostDetailsReportRequestDefinition

Definicja szczegółowego raportu dotyczącego kosztów.

Nazwa	Typ	Opis
billingPeriod	string	Ten parametr może być używany tylko przez klientów Enterprise Agreement. Użyj formatu YearMonth (np. 202008). Tego parametru nie można używać razem z parametrami invoiceId lub timePeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie zostanie podany w treści żądania, interfejs API zwróci koszt bieżącego miesiąca.
invoiceId	string	Ten parametr może być używany tylko przez klientów Umowa z Klientem Microsoft. Ponadto można jej używać tylko w zakresie profilu rozliczeniowego lub klienta. Tego parametru nie można używać razem z parametrami billingPeriod lub timePeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie zostanie podany w treści żądania, interfejs API zwróci koszt bieżącego miesiąca.
metric	CostDetailsMetricType	Typ szczegółowego raportu. Domyślnie jest udostępniany koszt rzeczywisty
timePeriod	CostDetailsTimePeriod	Określony zakres dat szczegółów kosztów żądany dla raportu. Tego parametru nie można używać razem z parametrami invoiceId lub billingPeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie zostanie podany w treści żądania, interfejs API zwróci koszt bieżącego miesiąca. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej i nie starsze niż 13 miesięcy. Jeśli parametr timePeriod lub billingPeriod lub invoiceId nie zostanie podany, interfejs API domyślnie ustawi okres godziny otwarcia miesiąca

Udostępnij za pośrednictwem