Получение данных об использовании из поставщика ресурсов
Область применения: Windows Пакет Azure
Извлекает данные об использовании из поставщика ресурсов.
Запрос
Замените <UsageEndpoint> адресом конечной точки для REST API Windows пользовательского поставщика ресурсов Azure Pack.
Метод |
Универсальный код ресурса (URI) запроса |
параметр "Версия HTTP" |
|---|---|---|
GET |
<https:// UsageEndpoint>/usage |
HTTP/1.1 |
Параметры URI
В следующей таблице описаны параметры URI.
Параметр универсального кода ресурса (URI) |
Описание |
|---|---|
lastID |
Идентификатор последней записи, полученной сборщиком использования. Параметр lastID пуст для первого запроса. Это подтверждение того, что сборщик использования распознает предыдущие записи и, следовательно, может удалить их. |
BatchSize |
Количество новых записей, отправляемых сборщику данных об использовании. Новые записи — это записи, которые соответствуют записи, определенной параметром lastID . Поставщик ресурсов может отправить меньший пакет, чем запрошенный, но не более крупный. |
Заголовки запросов
В следующей таблице перечислены обязательные и необязательные заголовки запросов.
Заголовок запроса |
Описание |
|---|---|
Авторизация: носитель |
Обязательный. Токен носителя авторизации. |
x-ms-principal-id |
Обязательный. Идентификатор участника. |
x-ms-client-request-id |
Необязательный элемент. Идентификатор запроса клиента. |
x-ms-client-session-id |
Необязательный элемент. Идентификатор сеанса клиента. |
x-ms-principal-liveid |
Необязательный элемент. Основной динамический идентификатор. |
Текст запроса
Отсутствует.
Ответ
Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК).
Дополнительные сведения о кодах состояния см. в разделе "Коды состояния" и "Коды ошибок" (Windows управление пакетом обновления Azure).
Заголовки откликов
Ответ для этой операции включает стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
Текст ответа
В следующей таблице описываются ключевые элементы текста ответа.
Имя элемента |
Описание |
|---|---|
EventId |
Обязательный. Уникальный идентификатор, представляющий каждую запись об использовании. Это значение будет соответствовать значению параметра URI lastID . |
ResourceId |
Необязательный элемент. Если поставщик ресурсов содержит несколько ресурсов для одной подписки и используется для агрегирования ресурса, это поле можно использовать для указания имени ресурса. Если использование агрегируется по идентификатору подписки, этот элемент не используется. |
StartTime |
Обязательный. Указывает, когда начинается сбор данных об использовании. |
EndTime |
Обязательный. Указывает, когда завершается сбор данных об использовании. |
ServiceType |
Обязательный. Уровень потребляемой службы. |
SubscriptionId |
Обязательный. Идентификатор подписки, для которой были собраны данные об использовании. (GUID). |
Свойства |
Необязательный элемент. Словарь пар "имя-значение", используемый для передачи дополнительных сведений об использовании. |
Ресурсы |
Обязательный. Словарь пар "имя-значение", представляющий выделенные или потребляемые ресурсы. Например, поставщик ресурсов SQL может иметь общее пространство и количество баз данных в качестве метрик. |
Примечания
Периодическое получение данных об использовании от поставщика ресурсов вызывается сборщиком использования для сбора сведений об использовании поставщика ресурсов. Эти сведения можно использовать для создания затрат на выставление счетов за использование поставщика ресурсов. Дополнительные сведения см. в описании конечных точек настраиваемого поставщика ресурсов. Дополнительные сведения о Windows службе использования пакета Azure см. в Windows службе использования пакета Azure.
См. также:
Windows справочник по REST API использования пользовательского поставщика ресурсов Azure Pack