API сервиса находится на стадии Preview.
Public API позволяет получать метрики, уже записанные в проект, но не вычислять новые.
Чтобы получить историю метрик:
Пройдите аутентификацию в API.
Выполните запрос:
curl -X GET --location "https://monitoring.api.cloud.ru/v1/{project_id}/export_metrics?match=условие" \ -H "Authorization: Bearer $TOKEN"В теле запроса укажите параметры:
match — обязательный параметр, фильтр для задания условий и получения данных о метриках. Введите валидный запрос в PromQL-формате, который возвращает массив значений. В запросе не поддерживаются функции и операторы сравнения, а также указание временного интервала.
Пример валидного запроса: match=metric_name, где metric_name — название метрики.
start — обязательный параметр, Unix timestamp в миллисекундах. Начало временного интервала, за который необходимо получить данные о метриках.
end — обязательный параметр, Unix timestamp в миллисекундах. Конец временного интервала, за который необходимо получить данные о метриках.
В ответ на запрос вернутся все значения метрик за указанный временной интервал, удовлетворяющие запросу.
{"metric":{"__name__":"metric_name","label_name":"label_value",...},"values":[value1,value2,..],"timestamps":[timestamp1,timestamp2,...]}Где:
metric_name — название метрики.
label_name — название лейбла метрики.
label_value — значение лейбла.
value — значение метрики.
timestamp — временная метка, указанная в Unix timestamp в миллисекундах.
Подробное описание параметров читайте в справочнике API.
Каждому
соответствует отдельная строчка в получаемом массиве данных в следующем формате:{"metric":{"__name__":"eiv_ballon_rss","name":"bm_vpc_2","id":"9b2eab6e-be9c-4527-a0a2-3c7e4be4534a","openstack_id":"cc8ec36b-03ed-4837-8d66-ff4f74936e7a","product_type":"evolution_iaas","project_id":"e3953394-c613-4074-b52b-012035c0eeb6"},"values":[37044,37044,37044],"timestamps":[1719878417000,1719878436000,1719878452000]}В результате одного запроса может вернуться максимум 30 000 таймсерий. Если их будет больше, вернется ошибка.
Максимальный временной интервал для одного запроса — семь дней.