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

Reservations Summaries - List By Reservation Order And Reservation

参考

服务:: Consumption

API 版本:: 2024-08-01

列出每日或每月粒度的预留摘要。注意：ARM 的有效负载大小限制为 12MB，因此，当响应大小超过 ARM 限制时，当前调用方将获得 400。在这种情况下，应使用较小的日期范围进行 API 调用。

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01

具有可选参数:

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&$filter={$filter}&api-version=2024-08-01

URI 参数

名称	在	必需	类型	说明
reservationId	path	True	string	预留的 ID
reservationOrderId	path	True	string	预留的订单 ID
api-version	query	True	string	要用于客户端请求的 API 的版本。当前版本为 2023-03-01。
grain	query	True	datagrain	可以是每日或每月
$filter	query		string	仅每日粒度是必需的。开始日期和结束日期的属性/UsageDate。筛选器支持“le”和“ge”

响应

名称	类型	说明
200 OK	ReservationSummariesListResult	还行。请求已成功。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

示例请求

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2024-08-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithReservationId

示例请求

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

定义

名称	说明
datagrain	可以是每日或每月
ErrorDetails	错误的详细信息。
ErrorResponse	错误响应指示服务无法处理传入请求。错误消息中提供了原因。一些错误响应： 429 TooManyRequests - 请求受到限制。等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。 503 ServiceUnavailable - 服务暂时不可用。在等待“Retry-After”标头中指定的时间后重试。 504 网关超时 - 处理请求时服务超时。尽可能减少请求中的日期范围。
ReservationSummariesListResult	列出预留摘要的结果。
ReservationSummary	预留摘要资源。

datagrain

枚举

可以是每日或每月

值	说明
daily	每日数据粒度
monthly	每月数据粒度

ErrorDetails

Object

错误的详细信息。

名称	类型	说明
code	string	错误代码。
message	string	指示作失败的原因的错误消息。

ErrorResponse

Object

错误响应指示服务无法处理传入请求。错误消息中提供了原因。

一些错误响应：

429 TooManyRequests - 请求受到限制。等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。
503 ServiceUnavailable - 服务暂时不可用。在等待“Retry-After”标头中指定的时间后重试。
504 网关超时 - 处理请求时服务超时。尽可能减少请求中的日期范围。

名称	类型	说明
error	ErrorDetails	错误的详细信息。

ReservationSummariesListResult

Object

列出预留摘要的结果。

名称	类型	说明
nextLink	string	指向下一页结果的链接（url）。
value	ReservationSummary[]	预留摘要列表。

ReservationSummary

Object

预留摘要资源。

名称	类型	说明
etag	string	资源的 etag。
id	string	事件的完整限定 ARM ID。
name	string	唯一标识事件的 ID。
properties.avgUtilizationPercentage	number (decimal)	这是整个时间范围内的平均利用率。（日或月，具体取决于粮食）
properties.kind	string	预留类型。
properties.maxUtilizationPercentage	number (decimal)	这是使用时间（日或月）中的最大小时利用率。例如，如果使用情况记录对应于 2017/12/10，并且 4 和 5 小时内利用率为 100%，则此字段将返回当天的 100%。
properties.minUtilizationPercentage	number (decimal)	这是使用时间（日或月）中的最小小时利用率。例如，如果使用情况记录对应于 2017 年 12 月 10 日，并且 4 和 5 小时内利用率为 10%，则此字段将返回当天的 10%
properties.purchasedQuantity	number (decimal)	这是 reservationId 的购买数量。
properties.remainingQuantity	number (decimal)	这是 reservationId 的剩余数量。
properties.reservationId	string	预留 ID 是预留订单中预留的标识符。每个预留是应用权益范围的分组，还指定了预留权益可应用于的实例数。
properties.reservationOrderId	string	预留订单 ID 是预留购买的标识符。每个预留订单 ID 表示单个购买交易。预留订单包含预留。预留顺序指定预留的 VM 大小和区域。
properties.reservedHours	number (decimal)	这是保留的总小时数。例如，如果在下午 1 点预留 1 个实例，则这一天为 11 小时，从后续天数起为 24 小时
properties.skuName	string	这是 ARM Sku 名称。它可用于在使用情况记录中的其他信息中加入 serviceType 字段。
properties.totalReservedQuantity	number (decimal)	这是为 reservationId 保留的实例总数。
properties.usageDate	string (date-time)	与利用率记录对应的数据。如果数据粒度为每月，则为每月的第一天。
properties.usedHours	number (decimal)	预留使用的总小时数
properties.usedQuantity	number (decimal)	这是 reservationId 的使用数量。
properties.utilizedPercentage	number (decimal)	这是预留 ID 的已利用百分比。
tags	object	资源标记。
type	string	资源类型。

通过

Reservations Summaries - List By Reservation Order And Reservation

URI 参数

响应

安全性

azure_auth

作用域

示例

ReservationSummariesDailyWithReservationId

示例请求

示例响应

ReservationSummariesMonthlyWithReservationId

示例请求

示例响应

定义

datagrain

ErrorDetails

ErrorResponse

ReservationSummariesListResult

ReservationSummary

其他资源