nav-img
Evolution

Метод для получения информации о потреблении (API v2)

Примечание

Просим обновить ваши системы в связи с обновлением API.

В ответах API v1/v2 теперь доступно новое поле id, заменяющее encode_id. Этот переход поможет улучшить консистентность данных в ответах. В ближайшее время поле encode_id будет удалено из ответов API. Запланируйте переход на поле id при идентификации записей.

С помощью API можно запросить потребление за один или несколько дней. В ответе приходит информация о потреблении с детализацией по ресурсам и квантам потребления за день с дополнительной метаинформацией по платформам.

Для запроса доступны данные за последние 6 месяцев. Наиболее быстро и корректно отрабатывают запросы данных не превышающие 3 месяцев.

Описание параметров

Описание параметров, а также примеры запросов и ответов собраны на странице Получение потребления по ресурсам (v2). Опирайтесь на нее при работе с API.

Дополнительно можете изучить рекомендации по работе с параметрами:

Обратите внимание, что в ответах удаленные записи отмечаются флагом is_delete: true. Такие записи необходимо воспринимать как удаленные в источнике, следует игнорировать такие записи и не учитывать их при построении отчетов и агрегатов.

Метаданные платформ

В ответах могут содержаться метаданные платформ, например:

Платформа Advanced

  • iam_project_id — идентификатор IAM-проекта.

  • iam_project_name — наименование проекта IAM.

  • enterprise_project_id — идентификатор Enterprise-проекта.

  • enterprise_project_name — наименование Enterpise-проекта.

  • az_code — указание на зону доступности (AZ).

  • tenant_name — название тенанта, в котором развернут сервис.

  • extended_params — расширенные параметры.

Платформа ML Space

  • product_instance_name — название продуктового инстанса, в котором развернут сервис.

Платформа Облако VMware

  • tenant — название тенанта.

  • vdc — название VDC.

Рекомендации по ошибкам

Если при выполнении запроса вы получили ошибку с одним из кодов ниже, изучите возможные причины их возникновения и рекомендации по устранению в таблице ниже.

Код ошибки

Возможная причина

Рекомендации

500 - failed to get agreement

Внутренняя ошибка сервиса

Обратитесь в техническую поддержку

500 - failed to get projects

Внутренняя ошибка сервиса

Обратитесь в техническую поддержку

500 - failed to get consumption

Внутренняя ошибка сервиса, связанная с получением потребления по заданным параметрам

Попробуйте повторить запрос позднее.