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

Reservations Details - List

列出定义的范围和提供的日期范围的预留详细信息。 注意:ARM 的有效负载大小限制为 12MB,因此当响应大小超过 ARM 限制时,当前调用方将获得 502。 在这种情况下,应使用较小的日期范围进行 API 调用。

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?api-version=2021-10-01
GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}&api-version=2021-10-01

URI 参数

Name In Required Type Description
resourceScope
path True
  • string

与预留详细信息操作关联的范围。 这包括 BillingAccount 范围 (旧) 的“/providers/Microsoft.Billing/billingAccountId}”和“/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}”, (新式) 。

api-version
query True
  • string

要用于客户端请求的 API 的版本。 当前版本为 2021-10-01。

$filter
query
  • string

按日期范围筛选预留详细信息。 开始日期和结束日期的属性/UsageDate。 筛选器支持“le”和“ge”。 使用计费配置文件进行查询时不适用

endDate
query
  • string

结束日期。 仅当使用计费配置文件进行查询时适用

reservationId
query
  • string

预留 ID GUID。 仅当同时提供 reservationOrderId 时有效。 筛选为特定预留

reservationOrderId
query
  • string

预留订单 ID GUID。 如果提供了 reservationId,则是必需的。 筛选到特定预留订单

startDate
query
  • string

开始日期。 仅当使用计费配置文件进行查询时适用

响应

Name Type Description
200 OK

没问题。 请求已成功。

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ReservationDetailsByBillingAccountId
ReservationDetailsByBillingProfileId
ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails?$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05&api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2017-11-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileId

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileIdReservationId

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc&api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

定义

ErrorDetails

错误的详细信息。

ErrorResponse

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

某些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 等待“Retry-After”标头中指定的时间后重试。

ReservationDetail

预留详细信息资源。

ReservationDetailsListResult

列出预留详细信息的结果。

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

指示操作失败的原因的错误消息。

ErrorResponse

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

某些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 等待“Retry-After”标头中指定的时间后重试。

Name Type Description
error

错误的详细信息。

ReservationDetail

预留详细信息资源。

Name Type Description
etag
  • string

资源的 etag。

id
  • string

事件的完整限定 ARM ID。

name
  • string

唯一标识事件的 ID。

properties.instanceFlexibilityGroup
  • string

实例灵活性组。

properties.instanceFlexibilityRatio
  • string

实例灵活性比率。

properties.instanceId
  • string

此标识符是资源名称或完全限定的资源 ID。

properties.kind
  • string

预留类型。

properties.reservationId
  • string

预留 ID 是预留订单中预留的标识符。 每个预留是用于应用权益范围的分组,还指定可以应用预留权益的实例数。

properties.reservationOrderId
  • string

预留订单 ID 是预留购买的标识符。 每个预留订单 ID 表示单个购买交易。 预留订单包含预留。 预留顺序指定预留的 VM 大小和区域。

properties.reservedHours
  • number

这是为当天保留的总小时数。 例如,如果在下午 1 点预留了 1 个实例,则这一天为 11 小时,从后续天数开始为 24 小时。

properties.skuName
  • string

这是 ARM Sku 名称。 它可用于在使用情况记录中的其他信息中加入 serviceType 字段。

properties.totalReservedQuantity
  • number

这是为 reservationId 保留的实例总数。

properties.usageDate
  • string

产生消耗的日期。

properties.usedHours
  • number

这是实例使用的总小时数。

tags
  • object

资源标记。

type
  • string

资源类型。

ReservationDetailsListResult

列出预留详细信息的结果。

Name Type Description
nextLink
  • string

指向下一页结果的链接 (url) 。

value

预留详细信息的列表。