企業のお客様向けの予約インスタンスの使用状況を取得する

[アーティクル]
03/05/2024

注意

2024 年 5 月 1 日に、Azure Enterprise Reporting API は廃止されます。残りのエンタープライズレポート API は、要求への応答を停止します。お客様は、その前に Microsoft Cost Management API の使用に移行する必要があります。詳細については、 Azure Enterprise Reporting から Microsoft Cost Management API への移行の概要に関するページを参照してください。

予約インスタンスの使用状況 API からは、加入契約内での予約インスタンス購入の使用状況が返されます。加入契約内に複数の予約インスタンスがある場合は、この API を使用して、すべての予約インスタンス購入の使用状況を取得できます。

予約インスタンスの使用状況の詳細の要求

必要な共通ヘッダープロパティについては、「エンタープライズ顧客向け Reporting API の概要」の記事を参照してください。

Method	要求 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
}

応答プロパティの定義

プロパティ名	Type	説明
reservationOrderId	string	予約注文 ID は、予約購入の識別子です。各予約注文 ID は、1 つの購入トランザクションを表します。予約注文には予約が含まれます。予約注文では、予約の VM サイズとリージョンを指定します。
reservationId	string	予約 ID は、予約注文内の予約の識別子です。各予約は、特典スコープを適用するためのグループであり、予約特典を適用できるインスタンスの数も指定します。
usageDate	string	消費が発生した日付。
skuName	string	これは Azure Resource Manager Sku 名です。使用レコードの additionalInfo 内の servicetype フィールドと結合するために使用できます。
instanceId	string	この識別子はリソース名または完全修飾リソース ID です。
totalReservedQuantity	string	これは、予約 ID 用に予約されているインスタンスの合計数です。
reservedHours	decimal	これは、その日に予約された合計時間です。たとえば、1 つのインスタンスの予約が午後 1 時に行われた場合、予約時間は最初の日は 11 時間、それ以降の日は 24 時間になります。
usedHours	decimal	これは、インスタンスによって使用される合計時間です。

予約インスタンスの使用状況の概要の要求

必要な共通ヘッダープロパティについては、「エンタープライズ顧客向け Reporting API の概要」の記事を参照してください。 API では、毎日および毎月のグレインの予約使用率がサポートされます。 Startdate パラメーターと EndDate パラメーターは、月単位のデータには必要ありません。

Method	要求 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
    }
]