Обзор API- интерфейсов отчетов для корпоративных клиентов

  • Статья
  • Чтение занимает 2 мин

Примечание

Корпорация Майкрософт больше не обновляет API-интерфейсы для корпоративной отчетности (выставление счетов). Вместо них используйте интерфейсы API потребления ресурсов Azure.

Интерфейсы API отчетов позволяют корпоративным клиентам Azure извлекать данные о потреблении и выставлении счетов программным способом и передавать их в предпочитаемые средства анализа данных. Клиенты, которые подписали Соглашение Enterprise (EA) с Azure и тем самым согласовали предоплату Azure (прежнее название — денежное обязательство) и получили доступ к пользовательским тарифам на ресурсы Azure.

Все параметры даты и времени, используемые API, должны быть представлены в виде значений времени в формате UTC. Значения, возвращаемые API, отображаются в формате UTC.

Включение доступа данных к API

  • Создание или получение ключа API. Войдите на корпоративный портал и последовательно выберите "Отчеты > Скачать сведения об использовании > Ключ доступа к API", чтобы создать или получить ключ API.
  • Передача ключей в API. Для аутентификации и авторизации необходимо передать ключ API для каждого вызова. В заголовки HTTP необходимо добавить следующее свойство:
Ключ заголовка запроса Значение
Авторизация Укажите значение в следующем формате: bearer {API_KEY}
Пример: bearer eyr....09

API-интерфейсы на основе потребления

Здесь вы можете найти конечную точку Swagger для интерфейсов API, описанных ниже. С ее помощью можно упростить самоанализ API и создать клиентские пакеты SDK, используя AutoRest или Swagger CodeGen. С 1 мая 2014 г. данные доступны через этот API.

  • Баланс и сводка. Интерфейс API для управления балансом и просмотра сводки отображает ежемесячную сводку о состоянии баланса, новых покупках, расходах на службу Azure Marketplace, корректировках и оплате за избыток.

  • Сведения об использовании. Интерфейс API сведений об использовании предоставляет сводку об израсходованных объемах и предполагаемых расходах для каждой регистрации с разбивкой по дням. Результаты также содержат сведения об экземплярах, метриках и отделах. Запрашивать данные в API можно по расчетному периоду или по дате начала и окончания.

  • Платежи в Marketplace. Интерфейс API платежей в Marketplace отображает сводку о расходах в Marketplace с разбивкой по дням. Данные основаны на фактическом использовании и отображаются для указанного расчетного периода или дат начала и окончания (однократные сборы не включаются).

  • Прейскурант. API прейскуранта предоставляет соответствующий тариф для каждой метрики в отдельной регистрации и за определенный расчетный период.

  • Сведения о зарезервированных экземплярах.API использования зарезервированных экземпляров возвращает данные о покупках использования зарезервированных экземпляров. API расходов на зарезервированные экземпляры отображает данные о выставленных счетах.

Актуальность данных

Теги ETag возвращаются в ответе API, упомянутого выше. Изменение ETag означает, что данные обновлены. В последующих вызовах этого же API с теми же параметрами передайте записанный ETag с ключом If-None-Match в заголовке HTTP-запроса. Код состояния будет содержать ответ NotModified, если данные больше не обновлялись, и данные не будут возвращены. API будет возвращать полный набор данных за требуемый период при каждом изменении ETag.

Интерфейсы API вспомогательного приложения

Список расчетных периодов. API расчетных периодов возвращает список расчетных периодов, которые содержат данные о потреблении для определенной регистрации, приведенные в обратном хронологическом порядке. Каждый период содержит свойство, указывающее на маршрут API к четырем наборам данных: BalanceSummary, UsageDetails, Marketplace Charges и Price Sheet.

Коды ответов API

Код состояния отклика Сообщение Описание
200 OK Без ошибок
400 Ошибка запроса Недопустимые параметры — диапазоны дат, числа EA и т. д.
401 Не авторизовано Ключ API не найден, недопустимый формат, срок действия истек и т. д.
404 Рекомендации недоступны Не найдена конечная точка отчетов
429 TooManyRequests Запрос не обработан вследствие регулирования. Повторите попытку по окончании периода времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.
500 Ошибка сервера Непредвиденная ошибка при обработке запроса
503 ServiceUnavailable Служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.