你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

获取企业客户的预留实例使用情况

注意

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
}

响应属性定义

属性名称 类型 说明
reservationOrderId 字符串 预留订单 ID 是预留购买的标识符。 每个预留订单 ID 表示一个购买交易。 预留订单包含预留。 预留订单指定预留的 VM 大小和区域。
reservationId 字符串 预留 ID 是预留订单中预留的标识符。 每个预留都是用于应用权益范围的分组,还指定可应用预留权益的实例数。
usageDate 字符串 产生消耗的日期。
skuName 字符串 这是 Azure 资源管理器 Sku 名称。 它可用于与使用情况记录中的 additionalInfo 中的 servicetype 字段联接。
instanceId 字符串 此标识符是资源名称或完全限定的资源 ID。
totalReservedQuantity 字符串 这是为预留 ID 保留的实例总数。
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
    }
]

响应属性定义

属性名称 类型 说明
reservationOrderId 字符串 预留订单 ID 是预留购买的标识符。 每个预留订单 ID 表示一个购买交易。 预留订单包含预留。 预留订单指定预留的 VM 大小和区域。
reservationId 字符串 预留 ID 是预留订单中预留的标识符。 每个预留都是用于应用权益范围的分组,还指定可应用预留权益的实例数。
usageDate 字符串 产生消耗的日期。
skuName 字符串 表示已购买资源的字符串。
reservedHours Decimal 为当天保留的总小时数。 例如,如果在下午 1 点预留了 1 个实例,则第一天的预留时间为 11 小时,后续日期为 24 小时。
usedHours Decimal 实例使用的总小时数。
minUtilizationPercentage Double 给定日期的最小利用率百分比。 如果购买了一个预留,并且有一个 VM 运行了 23 小时,则值为 0。
avgUtilizationPercentage Double 给定日期的平均利用率百分比。 如果购买一个预留并且有一个 VM 运行 23 小时,则值为 23/24。
MaxUtilizationPercentage Double 给定日期的最大利用率百分比。 如果购买了一个预留,并且有一个 VM 运行了 23 小时,则字段将为 1。

另请参阅