取得企業客戶的保留執行個體使用量

發行項
03/05/2024

注意

在 2024 年 5 月 1 日，Azure 企業報告 API 將會淘汰。任何剩餘的企業報告 API 都會停止回應要求。客戶必須在之前轉換至使用 Microsoft 成本管理 API。若要深入了解，請參閱從 Azure 企業版報告移轉至 Microsoft 成本管理 API 概觀。

保留執行個體使用量 API 會傳回註冊中所購買保留執行個體的使用量。如果註冊中有多個保留執行個體，您可以使用此 API 來取得所有保留執行個體購買的使用量。

保留執行個體使用量詳細資料的要求

請參閱適用於企業客戶的報告 API 概觀一文，以瞭解必要的通用標頭屬性。

方法	要求 URI
GET	`https://consumption.azure.com/v2/enrollments/{enrollmentNumber}/reservationdetails?startDate={yyyy-mm-dd}&endDate={yyyy-mm-dd}`

使用量詳細數據回應

[{
    "reservationOrderId": "00000000-0000-0000-0000-000000000000",
    "reservationId": "00000000-0000-0000-0000-000000000000",
    "usageDate": "2018-02-01T00:00:00",
    "skuName": "Standard_F2s",
    "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourvegroup1/providers/microsoft.compute/virtualmachines/VM1",
    "totalReservedQuantity": 18.000000000000000,
    "reservedHours": 432.000000000000000,
    "usedHours": 400.000000000000000
}

回應屬性定義

屬性名稱	類型	Description
reservationOrderId	字串	保留訂單標識碼是保留購買的標識碼。每個保留訂單標識碼都代表單一購買交易。保留訂單包含保留。保留順序會指定保留的 VM 大小和區域。
reservationId	字串	保留標識碼是保留訂單內保留的標識碼。每個保留都是套用權益範圍的群組，也會指定可套用保留權益的實例數目。
usageDate	字串	取用的發生日期。
skuName	字串	這是 Azure Resource Manager Sku 名稱。它可以用來與usage記錄中 additionalInfo 中的 servicetype 欄位聯結。
instanceId	字串	此識別碼是資源的名稱或完整的資源識別碼。
totalReservedQuantity	字串	這是保留標識碼保留的實例總數。
reservedHours	decimal	這是保留給當天的總時數。例如，如果在下午 1 點保留 1 個實例，保留時數會是第一天 11 小時，而後續天數為 24 小時。
usedHours	decimal	這是實例所使用的總時數。

保留實例使用量摘要的要求

請參閱適用於企業客戶的報告 API 概觀一文，以瞭解必要的通用標頭屬性。 API 支援每日和每月粒紋的保留使用率。每月數據不需要 Startdate 和 EndDate 參數。

方法	要求 URI
GET	`https://consumption.azure.com/v2/enrollments/{enrollmentNumber}/reservationsummaries?grain=daily&startdate={yyyy-mm-dd}&enddate={yyyy-mm-dd}`

使用量摘要回應

[
     {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_F1s",
        "reservedHours": 24,
        "usageDate": "2018-05-01T00:00:00",
        "usedHours": 23,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 95.83,
        "maxUtilizationPercentage": 100
    }
]