Generate Cost Details Report - Get Operation Results

Referens

Tjänst:: Cost Management

API-version:: 2023-11-01

Hämta resultatet av den angivna åtgärden. Den här länken finns i begärandesvarshuvudet för costdetails-skapande.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
operationId	path	True	string	Målåtgärdens ID.
scope	path	True	string	ARM-resurs-ID för prenumeration, faktureringskonto eller andra faktureringsomfång. För närvarande stöds inte resursgrupp och hanteringsgrupp. Mer information finns i https://aka.ms/costmgmt/scopes.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	CostDetailsOperationResults	OK. Begäran har slutförts.
202 Accepted		Accepterade. Åtgärden pågår.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get details of the operation result

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
}

Statuskod:: 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

Definitioner

Name	Description
BlobInfo	Blobinformationen som genereras av den här åtgärden.
CostDetailsDataFormat	Rapportens dataformat
CostDetailsMetricType	Typen av detaljerad rapport. Som standard tillhandahålls ActualCost
CostDetailsOperationResults	Resultatet av den långvariga åtgärden för api:et för kostnadsinformation.
CostDetailsStatusType	Status för kostnadsinformationsåtgärden
CostDetailsTimePeriod	Start- och slutdatumet för att hämta data för den kostnads detaljerade rapporten. API:et tillåter endast att data hämtas i en månad eller mindre och inte äldre än 13 månader.
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar: 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.
GenerateCostDetailsReportRequestDefinition	Definitionen av en detaljerad kostnadsrapport.

BlobInfo

Blobinformationen som genereras av den här åtgärden.

Name	Typ	Description
blobLink	string	Länka till bloben för att ladda ned filen.
byteCount	integer	Byte i bloben.

CostDetailsDataFormat

Rapportens dataformat

Name	Typ	Description
Csv	string	Csv-dataformat.

CostDetailsMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost

Name	Typ	Description
ActualCost	string	Faktiska kostnadsdata.
AmortizedCost	string	Amorterade kostnadsdata.

CostDetailsOperationResults

Resultatet av den långvariga åtgärden för api:et för kostnadsinformation.

Name	Typ	Description
error	ErrorDetails	Information om felet.
id	string	ID:t för den långvariga åtgärden.
manifest.blobCount	integer	Det totala antalet blobar.
manifest.blobs	BlobInfo[]	Lista över blobinformation som genereras av den här åtgärden.
manifest.byteCount	integer	Det totala antalet byte i alla blobar.
manifest.compressData	boolean	Är data i komprimerat format.
manifest.dataFormat	CostDetailsDataFormat	Rapportens dataformat
manifest.manifestVersion	string	Manifestversionen.
manifest.requestContext.requestBody	GenerateCostDetailsReportRequestDefinition	Begärandenyttolasttexten som anges i anropet kostnadsinformation
manifest.requestContext.requestScope	string	Begärans omfattning.
name	string	Namnet på den långvariga åtgärden.
status	CostDetailsStatusType	Status för kostnadsinformationsåtgärden
type	string	Typ av tidskrävande åtgärd.
validTill	string	Den tid då rapport-URL:en blir ogiltig/upphör att gälla i UTC, t.ex. 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

Status för kostnadsinformationsåtgärden

Name	Typ	Description
Completed	string	Åtgärden har slutförts.
Failed	string	Åtgärden misslyckades.
NoDataFound	string	Åtgärden har slutförts och inga kostnadsdata hittades.

CostDetailsTimePeriod

Start- och slutdatumet för att hämta data för den kostnads detaljerade rapporten. API:et tillåter endast att data hämtas i en månad eller mindre och inte äldre än 13 månader.

Name	Typ	Description
end	string	Slutdatumet som data ska hämtas till. exempelformat 2020-03-15
start	string	Startdatumet som data ska hämtas från. exempelformat 2020-03-15

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

Name	Typ	Description
error	ErrorDetails	Information om felet.

GenerateCostDetailsReportRequestDefinition

Definitionen av en detaljerad kostnadsrapport.

Name	Typ	Description
billingPeriod	string	Den här parametern kan endast användas av Enterprise-avtal kunder. Använd formatet YearMonth (t.ex. 202008). Den här parametern kan inte användas tillsammans med parametrarna invoiceId eller timePeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad.
invoiceId	string	Den här parametern kan bara användas av Microsoft-kundavtal kunder. Dessutom kan den endast användas i faktureringsprofilens eller kundens omfång. Den här parametern kan inte användas tillsammans med parametrarna billingPeriod eller timePeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad.
metric	CostDetailsMetricType	Typen av detaljerad rapport. Som standard tillhandahålls ActualCost
timePeriod	CostDetailsTimePeriod	Det specifika datumintervallet för den kostnadsinformation som begärs för rapporten. Den här parametern kan inte användas tillsammans med parametrarna invoiceId eller billingPeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad. API:et tillåter endast att data hämtas i en månad eller mindre och inte äldre än 13 månader. Om ingen timePeriod, billingPeriod eller invoiceId har angetts används API:et som standard för den öppna månadens tidsperiod

Dela via