Generate Cost Details Report - Get Operation Results

Odwołanie

Usługa:: Cost Management

Wersja interfejsu API:: 2024-08-01

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

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}?api-version=2024-08-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 minLength: 1	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 protokołu 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=2024-08-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": "2024-08-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=2024-08-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 o kosztach. 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ć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie. Niektóre odpowiedzi na błędy: 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".
GenerateCostDetailsReportRequestDefinition	Definicja szczegółowego raportu dotyczącego kosztów.

BlobInfo

Objekt

Informacje o obiekcie blob wygenerowane przez tę operację.

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

CostDetailsDataFormat

Wyliczanie

Format danych raportu

Wartość	Opis
Csv	Format danych csv.

CostDetailsMetricType

Wyliczanie

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

Wartość	Opis
ActualCost	Dane dotyczące kosztów rzeczywistych.
AmortizedCost	Dane dotyczące kosztu zamortyzowanego.

CostDetailsOperationResults

Objekt

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 (int32)	Całkowita liczba obiektów blob.
manifest.blobs	BlobInfo[]	Lista informacji o obiektach blob wygenerowanych przez tę operację.
manifest.byteCount	integer (int64)	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 (date-time)	Czas, w którym adres URL raportu staje się nieprawidłowy/wygasa w utc, np. 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

Wyliczanie

Stan operacji szczegółów kosztów

Wartość	Opis
Completed	Operacja jest zakończona.
Failed	Operacja nie powiodła się.
NoDataFound	Operacja jest ukończona i nie znaleziono danych kosztów.

CostDetailsTimePeriod

Objekt

Data rozpoczęcia i zakończenia ściągania danych dla szczegółowego raportu o kosztach. 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

Objekt

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

Objekt

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

Niektóre odpowiedzi na błędy:

429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".

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

GenerateCostDetailsReportRequestDefinition

Objekt

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

Nazwa	Typ	Opis
billingPeriod	string	Ten parametr może być używany tylko przez klientów z umową 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 jest 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 z Umową z Klientem Microsoft. Ponadto można go używać tylko w obszarze Profil rozliczeniowy lub Zakres klienta. Tego parametru nie można używać razem z parametrami billingPeriod lub timePeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest 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 żądanych dla raportu. Tego parametru nie można użyć obok parametrów invoiceId lub billingPeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest 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 interfejs API nie ma wartości timePeriod lub billingPeriod lub invoiceId, interfejs API jest domyślnie udostępniany okresowi czasu otwartego miesiąca

Udostępnij za pośrednictwem

Generate Cost Details Report - Get Operation Results

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Get details of the operation result

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BlobInfo

CostDetailsDataFormat

CostDetailsMetricType

CostDetailsOperationResults

CostDetailsStatusType

CostDetailsTimePeriod

ErrorDetails

ErrorResponse

GenerateCostDetailsReportRequestDefinition

Dodatkowe zasoby