Reservations Details - List

Ссылка

Служба:: Consumption

Версия API:: 2024-08-01

Выводит сведения о резервировании для предоставленного диапазона дат. Примечание. Arm имеет ограничение на полезные данные в 12 МБ, поэтому вызывающие в настоящее время получают 400, когда размер отклика превышает ограничение ARM. Если размер данных слишком велик, клиенты также могут получить 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

Имя	В	Обязательно	Тип	Описание
resourceScope	path	True	string	Область, связанная с операциями сведений о резервировании. Это включает в себя "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" для области BillingAccount (устаревшая версия) и "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" для области BillingProfile (современная).
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 2023-03-01.
$filter	query		string	Фильтрация сведений о резервировании по диапазону дат. Свойства/UsageDate для даты начала и даты окончания. Фильтр поддерживает le и ge. Неприменимо при запросе с помощью профиля выставления счетов
endDate	query		string	Дата окончания. Применимо только при запросе с помощью профиля выставления счетов
reservationId	query		string	GUID идентификатора резервирования. Допустимо только в том случае, если резервированиеOrderId также предоставляется. Фильтрация по определенному резервированию
reservationOrderId	query		string	Guid идентификатора заказа резервирования. Требуется, если указан идентификатор резервирования. Фильтрация по определенному заказу резервирования
startDate	query		string	Дата начала. Применимо только при запросе с помощью профиля выставления счетов

Ответы

Имя	Тип	Описание
200 OK	ReservationDetailsListResult	ХОРОШО. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
      }
    }
  ]
}

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After. Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.
ReservationDetail	ресурс сведений о резервировании.
ReservationDetailsListResult	Результат перечисления сведений о резервировании.

ErrorDetails

Object

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Object

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
Время ожидания шлюза 504— время ожидания службы при обработке запроса. Если это возможно, уменьшите диапазон дат в запросе.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке.

ReservationDetail

Object

ресурс сведений о резервировании.

Имя	Тип	Описание
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	Идентификатор заказа на резервирование — это идентификатор покупки резервирования. Каждый идентификатор заказа на резервирование представляет одну транзакцию покупки. Заказ на резервирование содержит резервирования. Порядок резервирования определяет размер виртуальной машины и регион резервирования.
properties.reservedHours	number (decimal)	Это общее время, зарезервированное в течение дня. Например, если резервирование для 1 экземпляра было сделано 1 вечера, это будет 11 часов в течение этого дня и 24 часов с последующих дней.
properties.skuName	string	Это имя SKU ARM. Его можно использовать для присоединения к полю serviceType в дополнительных сведениях в записях об использовании.
properties.totalReservedQuantity	number (decimal)	Это общее количество экземпляров, зарезервированных для идентификатора резервирования.
properties.usageDate	string (date-time)	Дата, по которой произошло потребление.
properties.usedHours	number (decimal)	Это общее время, используемое экземпляром.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

ReservationDetailsListResult

Object

Результат перечисления сведений о резервировании.

Имя	Тип	Описание
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	ReservationDetail[]	Список сведений о резервировании.

Поделиться через

Reservations Details - List

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

ReservationDetailsByBillingAccountId

Образец запроса

Пример ответа

ReservationDetailsByBillingProfileId

Образец запроса

Пример ответа

ReservationDetailsByBillingProfileIdReservationId

Образец запроса

Пример ответа

Определения

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult