Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Monitoring
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Работа с метриками
      • Поставка системных метрик Linux
      • Поставка метрик пользовательских приложений
      • Поставка метрик HAProxy и других сторонних приложений
      • Поставка метрик с хостов вне Yandex Cloud
      • Запись пользовательских метрик через API
      • Получение списка метрик
      • Выгрузка метрик
      • Экспорт метрик в формате Prometheus
    • Работа с дашбордами
      • Создание дашборда
      • Копирование дашборда
      • Добавление виджета на дашборд
      • Удаление виджета с дашборда
      • Удаление дашборда
      • Примеры работы с gRPC API
    • Работа с алертами
      • Создание алерта
      • Создание канала уведомлений
      • Удаление алерта
  • Концепции
    • Обзор сервиса
    • Модель данных
    • Визуализация
      • Обзор
      • Строка запроса
      • Виджеты
      • Дашборд
    • Передача метрик
      • Агент для поставки метрик
        • Обзор
        • Установка и запуск
        • Конфигурирование
        • Рекомендации по использованию агента
    • Язык запросов
    • Алертинг
    • Прореживание данных
    • Удаление устаревших метрик (TTL)
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • Правила до 1 октября 2020 года
  • Справочник API
    • Аутентификация в API
    • REST
      • Обзор
      • MetricsData
        • Обзор
        • read
        • write
        • prometheusMetrics
      • MetricsMeta
        • Обзор
        • listLabelKeys
        • listLabelValues
        • listMetricNames
        • listMetrics
    • gRPC (англ.)
      • Обзор
      • DashboardService
  • Справочник метрик
  • Вопросы и ответы
    • Общие вопросы
    • Навигация
    • Сбор и экспорт метрик
    • Метрики и единицы измерения
    • Алерты / уведомления
    • Все вопросы на одной странице
  1. Справочник API
  2. REST
  3. MetricsData
  4. write

Метод write

Статья создана
Yandex Cloud
  • HTTP-запрос
  • Query-параметры
  • Параметры в теле запроса
  • Ответ

Записывает данные метрик.

HTTP-запрос

POST https://monitoring.api.cloud.yandex.net/monitoring/v2/data/write

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога, которому принадлежит метрика. Максимальная длина строки в символах — 50.
service Обязательное поле. Идентификатор сервиса, которому принадлежит метрика. Используйте service=custom для пользовательских метрик. Максимальная длина строки в символах — 50.

Параметры в теле запроса

{
  "ts": "string",
  "labels": "object",
  "metrics": [
    {
      "name": "string",
      "labels": "object",
      "type": "string",
      "ts": "string",
      "value": "number",
      "timeseries": [
        {
          "ts": "string",
          "value": "number"
        }
      ]
    }
  ]
}
Поле Описание
ts string (date-time)

Общая временная метка для всех метрик в формате RFC3339.

labels object

Список меток общих для всех передаваемых метрик в формате ключ:значение.

metrics[] object

Список метрик.

metrics[].
name
string

Обязательное поле. Имя метрики.

metrics[].
labels
object

Список меток метрики в формате ключ:значение.

metrics[].
type
string

Тип метрики. Значение по умолчанию — DGAUGE.

  • DGAUGE: Числовой показатель. Задается дробным числом.
  • IGAUGE: Числовой показатель. Задается целым числом.
  • COUNTER: Счетчик.
  • RATE: Производная.
metrics[].
ts
string (date-time)

Временная метка в формате RFC3339. Если не указано, будет использовано текущее время.

metrics[].
value
number (double)

Обязательное поле. Значение метрики в указанной точке.

metrics[].
timeseries[]
object

Список из нескольких точек.

metrics[].
timeseries[].
ts
string (date-time)

Временная точка в формате RFC3339.

metrics[].
timeseries[].
value
number (double)

Значение метрики в указанной точке.

Ответ

HTTP Code: 200 - OK

{
  "writtenMetricsCount": "string",
  "errorMessage": "string"
}
Поле Описание
writtenMetricsCount string (int64)

Количество успешно записанных метрик.

errorMessage string

Сообщение об ошибке, если запись завершилась неуспешно.

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • HTTP-запрос
  • Query-параметры
  • Параметры в теле запроса
  • Ответ