Метод write

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

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

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