Метод read
Возвращает данные метрик.
HTTP-запрос
POST https://monitoring.api.cloud.yandex.net/monitoring/v2/data/read
Query-параметры
Параметр | Описание |
---|---|
folderId | Обязательное поле. Идентификатор каталога, которому принадлежит метрика. Максимальная длина строки в символах — 50. |
Параметры в теле запроса
{
"query": "string",
"fromTime": "string",
"toTime": "string",
"downsampling": {
"gridAggregation": "string",
"gapFilling": "string",
// `downsampling` включает только одно из полей `maxPoints`, `gridInterval`, `disabled`
"maxPoints": "string",
"gridInterval": "string",
"disabled": true,
// конец списка возможных полей `downsampling`
}
}
Поле | Описание |
---|---|
query | string Обязательное поле. Текст запроса. Синтаксис описан в разделе Язык запросов в Monitoring. |
fromTime | string (date-time) Обязательное поле. Начальная точка интервала в формате RFC3339. Строка в формате RFC3339. |
toTime | string (date-time) Обязательное поле. Конечная точка интервала в формате RFC3339. Строка в формате RFC3339. |
downsampling | object Обязательное поле. Параметры прореживания. |
downsampling. gridAggregation |
string Функция агрегации, которая используется для прореживания. Список доступных агрегирующих функций, которые используются при прореживании.
|
downsampling. gapFilling |
string Параметры заполнения пропусков в данных. Список методов для заполнения пропусков в данных при прореживании.
|
downsampling. maxPoints |
string (int64) downsampling включает только одно из полей maxPoints , gridInterval , disabled Максимальное количество точек, которое будет получено в ответе на запрос. Значение должно быть больше 10. |
downsampling. gridInterval |
string (int64) downsampling включает только одно из полей maxPoints , gridInterval , disabled Ширина временного окна (сетки) в миллисекундах. Используется для прореживания. Точки внутри окна объединяются в одну при помощи функции агрегации. Значение должно быть больше 0. |
downsampling. disabled |
boolean (boolean) downsampling включает только одно из полей maxPoints , gridInterval , disabled Указывает, что данные в ответе на запрос будут получены без прореживания. |
Ответ
HTTP Code: 200 - OK
{
"metrics": [
{
"name": "string",
"labels": "object",
"type": "string",
"timeseries": {
"timestamps": [
"number"
],
"doubleValues": [
"number"
],
"int64Values": [
"number"
]
}
}
]
}
Поле | Описание |
---|---|
metrics[] | object Список метрик с временными точками. |
metrics[]. name |
string Имя метрики. |
metrics[]. labels |
object Список меток метрики в формате |
metrics[]. type |
string Тип метрики.
|
metrics[]. timeseries |
object Значения метрик. |
metrics[]. timeseries. timestamps[] |
number (int64) Список временных меток в формате миллисекунд Unix. |
metrics[]. timeseries. doubleValues[] |
number (double) Список дробных значений метрик. |
metrics[]. timeseries. int64Values[] |
number (int64) Список целых значений метрик. Доступен только для метрик с типом |