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

Reservations Summaries - List By Reservation Order And Reservation

  • Ссылка
Служба:
Consumption
Версия API:
2024-08-01

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

Идентификатор резервирования
reservationOrderId
 path True

string

Идентификатор заказа резервирования
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

Поток OAuth2 Azure Active Directory.

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

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ReservationSummariesDailyWithReservationId
ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

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

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

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

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 события.
name

string

Идентификатор, который однозначно идентифицирует событие.
properties.avgUtilizationPercentage

number (decimal)

Это среднее использование для всего диапазона времени. (день или месяц в зависимости от зерна)
properties.kind

string

Тип резервирования.
properties.maxUtilizationPercentage

number (decimal)

Это максимальное почасовое использование в период использования (день или месяц). Например, если запись об использовании соответствует 12.10.2017 и в течение часа 4 и 5, использование составило 100%, это поле вернет 100% в течение этого дня.
properties.minUtilizationPercentage

number (decimal)

Это минимальное почасовое использование в течение времени использования (день или месяц). Например, если запись об использовании соответствует 12.10.2017 и в течение часа 4 и 5, использование было 10%, это поле вернет 10% в течение этого дня.
properties.purchasedQuantity

number (decimal)

Это приобретенное количество для идентификатора резервирования.
properties.remainingQuantity

number (decimal)

Это оставшееся количество для идентификатора резервирования.
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)

Общее количество используемых часов резервирования
properties.usedQuantity

number (decimal)

Это используемое количество для идентификатора резервирования.
properties.utilizedPercentage

number (decimal)

Это процент использования для идентификатора резервирования.
tags

object

Теги ресурсов.
type

string

Тип ресурса.