/ DOCS
nav-img
Evolution

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

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

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

Особенности работы с API:
См.также

Какой временной период лучше указывать при запросе данных потребления через API?

Как получить изменения данных, полученных через API ранее?

Где найти ID договора (agreement_id)?

Получение потребления по ресурсам
Query Parameters

  • agreement_id (string) – Обязательное поле (либо project_ids). Фильтр по id договора.

  • project_ids (array) – Обязательное поле (либо agreement_id). Фильтр по id проекта.

  • service_names (array) – Фильтр по названиям сервисов.

  • start_date (string) – Обязательное поле. Фильтр по дате начала периода.

  • end_date (string) – Обязательное поле. Фильтр по дате окончания периода.

  • page_filter.page_size (integer) – Лимит сущностей на странице. Рекомендуемое значение - не более 25 000.

  • page_filter.page_token (integer) – Токен страницы, полученный в предыдущем ответе в поле next_page_token. Передается вместе с page_filter.page_size.

  • start_updated_dt (string) – Фильтр по времени обновления записи. Дата начала периода.

  • end_updated_dt (string) – Фильтр по времени обновления записи. Дата окончания периода.

  • sku_ids (array) – Фильтр по идентификаторам SKU.

Status Codes
Response JSON Object

  • consumptions (array) – Массив строк с потреблением.

  • consumptions[].amount (number) – Стоимость потребления без НДС.

  • consumptions[].amount_nds (number) – Стоимость потребления с НДС.

  • consumptions[].cost (number) – Тариф потребления сервиса без НДС.

  • consumptions[].encode_id (string) – Ключ-идентификатор записи.

  • consumptions[].meta (object) – Дополнительная мета-информация об экземпляре ресурса.

  • consumptions[].platform (string) – Платформа сервиса.

  • consumptions[].product_instance_id (integer) – Идентификатор подключенного продукта.

  • consumptions[].resource_id (string) – Идентификатор экземпляра ресурса.

  • consumptions[].resource_name (string) – Название экземпляра ресурса.

  • consumptions[].servname (string) – Название облачного сервиса в продуктовом каталоге.

  • consumptions[].sku (string) – Идентификатор облачного сервиса в продуктовом каталоге.

  • consumptions[].unit (string) – Единица измерения для тарифа сервиса.

  • consumptions[].updated_dt (string) – Время обновления записи.

  • consumptions[].usedate (string) – Дата, за которую собрано потребление.

  • consumptions[].usefact (number) – Объем потребления сервиса.

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

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

Платформа 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.

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

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

 
/v2/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": [
    {
      "product_instance_id": "xxxxxxxx-xxxx-xxxx-xxxx",
      "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"
    }
  ]
}

Коды ошибок

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

Код ошибки

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

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

500 - failed to get agreement

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

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

500 - failed to get projects

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

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

500 - failed to get consumption

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

Попробуйте повторить запрос позднее.
Была ли статья полезной ?
Предыдущая статья
Метод для получения информации о потреблении (API v1)
Следующая статья
Использование пагинации
Поддержка Юридические документы
© 2025 Cloud.ru