Reservations Details - List

參考

服務:: Consumption

API 版本:: 2024-08-01

列出所提供日期範圍的保留詳細數據。注意：ARM 的承載大小限制為 12MB，因此當回應大小超過 ARM 限制時，目前呼叫端會收到 400。如果數據大小太大，客戶也可能收到 504，因為 API 已逾時準備數據。在這種情況下，API 呼叫應該使用較小的日期範圍進行，或應呼叫產生保留詳細數據報告 API，因為它是異步的，而且不會遇到回應時間逾時。

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?api-version=2024-08-01

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
resourceScope	path	True	string	與保留詳細數據作業相關聯的範圍。這包括 BillingAccount 範圍的 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' 和 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope （modern）。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前的版本是 2023-03-01。
$filter	query		string	依日期範圍篩選保留詳細數據。開始日期和結束日期的屬性/UsageDate。篩選支援『le』和 'ge'。使用帳單配置檔進行查詢時不適用
endDate	query		string	結束日期。僅適用於使用帳單配置檔進行查詢時
reservationId	query		string	保留標識碼 GUID。只有在也提供 reservationOrderId 時才有效。篩選至特定保留
reservationOrderId	query		string	保留訂單標識碼 GUID。如果提供 reservationId，則為必要專案。篩選至特定保留訂單
startDate	query		string	開始日期。僅適用於使用帳單配置檔進行查詢時

回應

名稱	類型	Description
200 OK	ReservationDetailsListResult	還行。要求已成功。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

範例要求

HTTP

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=2024-08-01

範例回覆

狀態碼:: 200

{
  "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

範例要求

HTTP

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=2024-08-01

範例回覆

狀態碼:: 200

{
  "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

範例要求

HTTP

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=2024-08-01

範例回覆

狀態碼:: 200

{
  "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"
      }
    }
  ]
}

定義

名稱	Description
ErrorDetails	錯誤的詳細數據。
ErrorResponse	錯誤回應表示服務無法處理傳入要求。錯誤訊息中會提供原因。某些錯誤回應： 429 TooManyRequests - 要求已節流。等候「x-ms-ratelimit-microsoft.consumption-retry-after」標頭中指定的時間後重試。 503 ServiceUnavailable - 服務暫時無法使用。等候「Retry-After」標頭中指定的時間後重試。 504 閘道逾時 - 處理要求時服務逾時。儘可能減少要求中的日期範圍。
ReservationDetail	保留詳細數據資源。
ReservationDetailsListResult	列出保留詳細數據的結果。

ErrorDetails

Object

錯誤的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。

ErrorResponse

Object

錯誤回應表示服務無法處理傳入要求。錯誤訊息中會提供原因。

某些錯誤回應：

429 TooManyRequests - 要求已節流。等候「x-ms-ratelimit-microsoft.consumption-retry-after」標頭中指定的時間後重試。
503 ServiceUnavailable - 服務暫時無法使用。等候「Retry-After」標頭中指定的時間後重試。
504 閘道逾時 - 處理要求時服務逾時。儘可能減少要求中的日期範圍。

名稱	類型	Description
error	ErrorDetails	錯誤的詳細數據。

ReservationDetail

Object

保留詳細數據資源。

名稱	類型	Description
etag	string	資源的 etag。
id	string	事件的完整ARM標識碼。
name	string	可唯一識別事件的標識碼。
properties.instanceFlexibilityGroup	string	實例彈性群組。
properties.instanceFlexibilityRatio	string	實例彈性比率。
properties.instanceId	string	此標識碼是資源的名稱或完整資源標識碼。
properties.kind	string	保留種類。
properties.reservationId	string	保留標識碼是保留訂單內保留的標識碼。每個保留都是套用權益範圍的群組，也會指定可套用保留權益的實例數目。
properties.reservationOrderId	string	保留訂單標識碼是保留購買的標識碼。每個保留訂單標識碼都代表單一購買交易。保留訂單包含保留。保留順序會指定保留的 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)	這是實例所使用的總時數。
tags	object	資源標籤。
type	string	資源類型。

ReservationDetailsListResult

Object

列出保留詳細數據的結果。

名稱	類型	Description
nextLink	string	結果下一頁的連結（url）。
value	ReservationDetail[]	保留詳細數據的清單。

共用方式為

Reservations Details - List

URI 參數

回應

安全性

azure_auth

範圍

範例

ReservationDetailsByBillingAccountId

範例要求

範例回覆

ReservationDetailsByBillingProfileId

範例要求

範例回覆

ReservationDetailsByBillingProfileIdReservationId

範例要求

範例回覆

定義

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult

其他資源