Generate Cost Details Report - Get Operation Results

  • 參考
服務:
Cost Management
API 版本:
2023-11-01

取得指定作業的結果。 此連結會在 CostDetails 建立要求回應位置標頭中提供。

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

URI 參數

名稱 位於 必要 類型 Description
operationId
 path True

string

目標作業標識碼。
scope
 path True

string

訂用帳戶、計費帳戶或其他計費範圍的 ARM 資源標識碼。目前不支援資源群組和管理群組。 如需詳細資訊，請參閱 https://aka.ms/costmgmt/scopes。
api-version
 query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

CostDetailsOperationResults

正常。 要求成功。
202 Accepted

已接受。 作業正在進行中。
Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Get details of the operation result

範例要求

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

範例回覆

狀態碼:
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"
}
狀態碼:
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

定義

名稱 Description
BlobInfo

此作業所產生的 Blob 資訊。
CostDetailsDataFormat

報表的數據格式
CostDetailsMetricType

詳細報表的類型。 預設會提供 ActualCost
CostDetailsOperationResults

成本詳細數據 Api 長時間執行作業的結果。
CostDetailsStatusType

成本詳細數據作業的狀態
CostDetailsTimePeriod

提取成本詳細報表數據的開始和結束日期。 API 只允許提取 1 個月或小於 13 個月的數據。
ErrorDetails

錯誤的詳細數據。
ErrorResponse

錯誤回應表示服務無法處理傳入要求。 錯誤訊息中提供了原因。

某些錯誤回應：

  • 429 TooManyRequests - 要求已節流。 等候 「x-ms-ratelimit-microsoft.consumption-retry-after」 標頭中指定的時間後重試。

  • 503 ServiceUnavailable - 服務暫時無法使用。 請在等候「Retry-After」標頭中指定的時間之後重試。
GenerateCostDetailsReportRequestDefinition

成本詳細報表的定義。

BlobInfo

此作業所產生的 Blob 資訊。

名稱 類型 Description
blobLink

string

連結至 Blob 以下載檔。
byteCount

integer

Blob 中的位元組。

CostDetailsDataFormat

報表的數據格式

名稱 類型 Description
Csv

string

Csv 數據格式。

CostDetailsMetricType

詳細報表的類型。 預設會提供 ActualCost

名稱 類型 Description
ActualCost

string

實際成本數據。
AmortizedCost

string

分攤成本數據。

CostDetailsOperationResults

成本詳細數據 Api 長時間執行作業的結果。

名稱 類型 Description
error

ErrorDetails

錯誤的詳細數據。
id

string

長時間執行作業的標識碼。
manifest.blobCount

integer

Blob 總數。
manifest.blobs

BlobInfo[]

此作業所產生的 Blob 資訊清單。
manifest.byteCount

integer

所有 Blob 中的位元組總數。
manifest.compressData

boolean

這是壓縮格式的數據。
manifest.dataFormat

CostDetailsDataFormat

報表的數據格式
manifest.manifestVersion

string

指令清單版本。
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

成本詳細數據呼叫中提供的要求承載本文
manifest.requestContext.requestScope

string

要求的要求範圍。
name

string

長時間執行作業的名稱。
status

CostDetailsStatusType

成本詳細數據作業的狀態
type

string

長時間執行的作業類型。
validTill

string

報表 URL 在 UTC 中變成無效/到期的時間，例如 2020-12-08T05：55：59.4394737Z。

CostDetailsStatusType

成本詳細數據作業的狀態

名稱 類型 Description
Completed

string

作業已完成。
Failed

string

作業失敗。
NoDataFound

string

作業已完成且找不到任何成本數據。

CostDetailsTimePeriod

提取成本詳細報表數據的開始和結束日期。 API 只允許提取 1 個月或小於 13 個月的數據。

名稱 類型 Description
end

string

要提取數據的結束日期。範例格式 2020-03-15
start

string

要從中提取數據的開始日期。 範例格式 2020-03-15

ErrorDetails

錯誤的詳細數據。

名稱 類型 Description
code

string

錯誤碼。
message

string

指出作業失敗原因的錯誤訊息。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。 錯誤訊息中提供了原因。

某些錯誤回應：

  • 429 TooManyRequests - 要求已節流。 等候 「x-ms-ratelimit-microsoft.consumption-retry-after」 標頭中指定的時間後重試。

  • 503 ServiceUnavailable - 服務暫時無法使用。 請在等候「Retry-After」標頭中指定的時間之後重試。

名稱 類型 Description
error

ErrorDetails

錯誤的詳細數據。

GenerateCostDetailsReportRequestDefinition

成本詳細報表的定義。

名稱 類型 Description
billingPeriod

string

此參數只能由 Enterprise 合約客戶使用。 使用 YearMonth (，例如202008) 格式。 此參數不能與 invoiceId 或 timePeriod 參數一起使用。 如果在要求本文中未提供 timePeriod、invoiceId 或 billingPeriod 參數，API 將會傳回目前月份的成本。
invoiceId

string

此參數只能由 Microsoft 客戶合約客戶使用。 此外，其只能用於帳單設定檔或客戶範圍。 此參數不能與 billingPeriod 或 timePeriod 參數一起使用。 如果在要求本文中未提供 timePeriod、invoiceId 或 billingPeriod 參數，API 將會傳回目前月份的成本。
metric

CostDetailsMetricType

詳細報表的類型。 預設會提供 ActualCost
timePeriod

CostDetailsTimePeriod

針對報表要求之成本詳細數據的特定日期範圍。 此參數不能與 invoiceId 或 billingPeriod 參數一起使用。 如果在要求本文中未提供 timePeriod、invoiceId 或 billingPeriod 參數，API 將會傳回目前月份的成本。 API 只允許提取 1 個月或小於 13 個月的數據。 如果未提供 timePeriod 或 billingPeriod 或 invoiceId，API 預設為開啟月份時間週期