Метод для получения информации о потреблении (API 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 — расширенные параметры.

Платформа ML Space

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

Пример запроса и ответа

Пример запроса:

/v1/consumption?
agreement_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx &
start_date = 2024 -06-01T00:00:00Z &
end_date = 2024 -06-09T00:00:00Z &
project_ids = xxxxxxxx-xxxx-xxxx-xxxxxxx01 &
project_ids = xxxxxxxx-xxxx-xxxx-xxxxxxx02 &
service_names = Привязка публичного IP адреса
start_updated_dt: 2024 -09-01T00:00:00Z
end_updated_dt: 2024 -10-01T00:00:00Z

Пример ответа:

{
"consumptions" : [
{
"dog_id" : "string" ,
"dmid" : 0 ,
"sku" : "string" ,
"servname" : "string" ,
"resource_id" : "string" ,
"resource_name" : "string" ,
"usedate" : "2024-08-14T07:50:48.912Z" ,
"amount" : 0 ,
"amount_nds" : 0 ,
"cost" : 0 ,
"unit" : "string" ,
"usefact" : 0 ,
"platform" : "string" ,
"meta" : {
"additionalProp1" : "string" ,
"additionalProp2" : "string" ,
"additionalProp3" : "string"
} ,
"updated_dt" : "2024-12-12T09:42:04.817Z" ,
"encode_id" : "string"
}
]
}

Коды ошибок

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

Код ошибки

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

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

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

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

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

Evolution