適用於企業客戶的報告 API - 使用量詳細資料
注意
在 2024 年 5 月 1 日，Azure 企業報告 API 將會淘汰。 任何剩餘的企業報告 API 都會停止回應要求。 客戶需要先轉換至使用 Microsoft 成本管理 API。 若要深入了解，請參閱從 Azure 企業版報告移轉至 Microsoft 成本管理 API 概觀。
此 API 僅支援指定資源最多 400 個標記字元的使用記錄。 如果您的記錄超過標籤數目上限，API 就可能會失敗。 如果您遇到此問題，請遷移至匯出或匯出 API。
使用量詳細資料 API 可提供註冊之使用量和預估費用的每日明細。 結果也包含執行個體、計量和部門的資訊。 API 可依計費週期或指定開始和結束日期來查詢。
需要新增的一般標頭屬性，指定於適用於企業客戶的報告 API 概觀中。 可以使用格式為 yyyy-MM-dd 的開始和結束日期參數來指定自訂的時間範圍。
CSV 格式
下列 API 會以 CSV 格式提供數據。
同步呼叫 (非輪詢)
我們會以 CSV 格式傳回數據作為 REST API 呼叫的回應。 API 效能取決於呼叫傳回的使用量數據量，最多可能需要 60 分鐘的時間。 雖然 API 支援自定義日期範圍，但建議您根據該期間內所擁有的使用量數據量來限制該範圍。 我們允許最多一個月支援。
| 方法 | 下載要求 URI |
|---|---|
| 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 |
異步呼叫 (以輪詢為基礎的)
呼叫是兩個步驟的程式，要求您先針對特定時間範圍提交要求，然後輪詢以取得具有 CSV 數據的 Azure Blob 位置共用存取密鑰型 URL。 此處支持的時間上限為 36 個月。 我們建議此 API 用於較大的數據集。
| 方法 | 提交要求 URI |
|---|---|
| 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 |
異步 (輪詢) 提交呼叫的回應
{
"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"
}
異步呼叫回應屬性定義
| 屬性名稱 | 類型 | Description |
|---|---|---|
| id | 字串 | 要求的唯一標識碼。 |
| enrollmentNumber | 字串 | 要求的註冊號碼。 |
| requestedOn | 字串 | 提出要求的日期時間。 |
| status | int | 指出要求的狀態。 Queued = 1， InProgress = 2， Completed = 3， Failed = 4， NoDataFound = 5， ReadyToDownload=6， TimedOut = 7. |
| blobPath | 字串 | csv Blob 的共用存取金鑰 URL。 |
| reportUrl | 字串 | 可用來輪詢提交要求狀態的 URL。 |
| startDate | 字串 | 對應至進行提交呼叫時所使用的時間範圍的開頭。 |
| endDate | 字串 | 對應至進行提交呼叫時所使用的時間範圍結束。 |
reportUrl 是可用來進一步輪詢呼叫的 URL， (GET 作業) 。 當輪詢要求回應中的狀態字段傳回為 3 時，要求就會完成。 我們在回應中填入了指向 csv 數據的 URL 中的 blobPath 字段。 Blob 可從要求的 [回應] 字段中的日期時間 1 天取得。 狀態 4、5 和 7 是 API 呼叫達到錯誤狀況的失敗狀態。 針對所有其他狀態，應該重複輪詢呼叫。
JSON 格式
下列 API 會以 JSON 格式提供數據。 如果未指定計費週期，則會傳回目前計費週期的資料。 支援的最大時間範圍是 36 個月。
| 方法 | 要求 URI |
|---|---|
| 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 |
注意
若要使用舊版的 API，請將 v3 取代為上述 URL 中的 v2。 如果您使用 v2，則無法使用某些欄位。
回應
由於數據量可能很大，因此結果集會分頁。 nextLink 屬性 (若存在) 會指定下一個資料分頁的連結。 如果連結是空的，則表示該分頁是最後一個分頁。
{
"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"
}
使用量詳細數據欄位定義
| 屬性名稱 | 類型 | Description |
|---|---|---|
| id | 字串 | API 呼叫的唯一識別碼。 |
| 資料 | JSON 陣列 | 每個執行個體\計量的每日使用量詳細資料陣列。 |
| nextLink | 字串 | 當有更多的資料分頁時，nextLink 會指向能傳回下一個資料分頁的 URL。 |
| accountId | int | 已淘汰的欄位。 之所以顯示是為了提供回溯相容性。 |
| productId | int | 已淘汰的欄位。 之所以顯示是為了提供回溯相容性。 |
| resourceLocationId | int | 已淘汰的欄位。 之所以顯示是為了提供回溯相容性。 |
| consumedServiceId | int | 已淘汰的欄位。 之所以顯示是為了提供回溯相容性。 |
| departmentId | int | 已淘汰的欄位。 之所以顯示是為了提供回溯相容性。 |
| accountOwnerEmail | 字串 | 帳戶擁有者的電子郵件帳戶。 |
| accountName | string | 客戶輸入的帳戶名稱。 |
| serviceAdministratorId | 字串 | 服務系統管理員的電子郵件地址。 |
| subscriptionId | int | 已淘汰的欄位。 之所以顯示是為了提供回溯相容性。 |
| subscriptionGuid | 字串 | 訂用帳戶的全域唯一識別碼。 |
| subscriptionName | 字串 | 訂閱的名稱。 |
| date | 字串 | 取用的發生日期。 |
| 產品 | 字串 | 計量的其他詳細資料。 |
| meterId | 字串 | 發出使用量之計量的識別碼。 |
| meterCategory | 字串 | 所使用的 Azure 平台服務。 |
| meterSubCategory | 字串 | 定義可能會影響費率的 Azure 服務類型。 |
| meterRegion | 字串 | 針對根據資料中心位置定價的某些服務，識別資料中心的位置。 |
| meterName | 字串 | 計量的名稱。 |
| consumedQuantity | double | 已耗用的計量數量。 |
| resourceRate | double | 每個可計費單位的適用費率。 |
| cost | double | 計量已產生的費用。 |
| resourceLocation | 字串 | 識別正在執行計量的資料中心。 |
| consumedService | 字串 | 所使用的 Azure 平台服務。 |
| instanceId | 字串 | 此識別碼是資源的名稱或完整的資源識別碼。 如需詳細資訊，請參閱 Azure Resource Manager API |
| serviceInfo1 | 字串 | 內部的 Azure 服務中繼資料。 |
| serviceInfo2 | 字串 | 例如，虛擬機器的映像類型和 ExpressRoute 的 ISP 名稱。 |
| additionalInfo | 字串 | 服務專屬的中繼資料。 例如，虛擬機器的影像類型。 |
| tags | 字串 | 客戶已新增的標記。 如需詳細資訊，請參閱使用標記組織您的 Azure 資源。 |
| storeServiceIdentifier | 字串 | 不使用這個資料行。 之所以顯示是為了提供回溯相容性。 |
| departmentName | 字串 | 部門名稱。 |
| costCenter | 字串 | 使用量的相關聯成本中心。 |
| unitOfMeasure | 字串 | 識別服務的計費單位。 範例：GB、小時、10,000 秒。 |
| resourceGroup | 字串 | 部署的資源正在其中執行的計量群組。 如需詳細資訊，請參閱 Azure Resource Manager 概觀。 |
| chargesBilledSeparately | 字串 | 在預付金之外計費的費用。 |
| location | 字串 | 部署服務的位置。 |
| offerId | 字串 | 對服務提供的 OfferId。 |
| partNumber | 字串 | 服務的 SKU 號碼。 |
| resourceGuid | 字串 | 發出使用量之計量的識別碼。 |
| serviceTier | 字串 | 服務層級。 |
| serviceName | 字串 | 服務名稱： |
速率限制
為了在客戶之間啟用一致的體驗，所有使用量 API 都會在註冊層級受到限制。 當您達到限制時，您會收到 HTTP 狀態代碼 429 太多要求。 目前間隔為 15 分鐘的輸送量如下：
| API | 速率限制 |
|---|---|
| NextPage | 1000 |
| 下載 | 50 |
| 輪詢 | 180 |
| 送出 | 20 |