Метод для получения информации о потреблении (API v1)
Просим обновить ваши системы в связи с обновлением API.
В ответах API v1/v2 теперь доступно новое поле id, заменяющее encode_id. Этот переход поможет улучшить консистентность данных в ответах. В ближайшее время поле encode_id будет удалено из ответов API. Запланируйте переход на поле id при идентификации записей.
С помощью API можно запросить потребление за один или несколько дней. В ответе приходит информация о потреблении с детализацией по ресурсам и квантам потребления за день с дополнительной метаинформацией по платформам.
Для запроса доступны данные за последние 90 дней.
Описание параметров
Описание параметров, а также примеры запросов и ответов собраны на странице Получение потребления по ресурсам (v1). Опирайтесь на нее при работе с API.
Дополнительно можете изучить рекомендации по работе с параметрами:
Метаданные платформ
В ответах могут содержаться метаданные платформ, например:
Платформа Advanced
iam_project_id — идентификатор IAM-проекта.
iam_project_name — наименование IAM-проекта.
enterprise_project_id — идентификатор Enterprise-проекта.
enterprise_project_name — наименование Enterpise-проекта.
az_code — указание на зону доступности (AZ).
tenant_name — название тенанта, в котором развернут сервис.
extended_params — расширенные параметры.
Платформа Distributed Train
product_instance_name — название продуктового инстанса, в котором развернут сервис.
Рекомендации по ошибкам
Если при выполнении запроса вы получили ошибку с одним из кодов ниже, изучите возможные причины их возникновения и рекомендации по устранению в таблице.
Код ошибки | Возможная причина | Рекомендации |
---|---|---|
429 - received message larger than max | Превышен допустимый объем выборки | Откорректируйте запрос: сократите период выборки и/или укажите параметр page_filter.limit не более 30 000. |
500 - failed to get agreement | Внутренняя ошибка сервиса | |
500 - failed to get projects | Внутренняя ошибка сервиса | |
500 - failed to get consumption | Внутренняя ошибка сервиса, связанная с получением потребления по заданным параметрам | Попробуйте повторить запрос позднее. |
- Описание параметров
- Метаданные платформ
- Рекомендации по ошибкам