GET определения метрик

API АппОптима / Эндпойнты среды / Развёртывание / Таймсерии v1 / Определение метрик / GET определения метрик

Получает определение указанной метрики.

Запрос создает application/jsonполезную нагрузку.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Чтобы получить определение метрики, но не ее точек данных, задайте для параметра includeDatafalse значение .

Параметр	Тип	Описание	In	Необходимость
timeseriesId	string	Идентификатор метрики с учетом регистра, из которой вы хотите прочитать параметры. Вы можете выполнить запрос определения метрик GET , чтобы получить список доступных метрик.	path	требуется
includeData	boolean	Отметьте, чтобы включить точки данных в ответ. Установите для `false`получения только определения метрики.	query	по желанию

Ответ

Результатом является объект JSON, содержащий параметры метрики. В этом случае объект TimeseriesDataPointQueryResult опущен.

Коды ответов

Код	Тип	Описание
200	Результат запроса временных рядов	Успех

Объекты тела ответа

Объект `TimeseriesQueryResult`

Конфигурация метрики со всеми ее параметрами и, при необходимости, точками данных.

Элемент	Тип	Описание
timeseriesId	string	Идентификатор метрики.
displayName	string	Имя метрики в пользовательском интерфейсе.
dimensions	string []	Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом.
aggregationTypes	string []	Список разрешенных агрегаций для этой метрики. Элемент может содержать эти значения `AVG` `COUNT` `MAX` `MEDIAN` `MIN` `PERCENTILE` `SUM`
unit	string	Единица измерения. Элемент может содержать эти значения `Billion (bilcount)` `Bit (bit)` `BitPerHour (bit/h)` `BitPerMinute (bit/min)` `BitPerSecond (bit/s)` `Byte (B)` `BytePerHour (B/h)` `BytePerMinute (B/min)` `BytePerSecond (B/s)` `Cores` `Count (count)` `Day (ds)` `DecibelMilliWatt (dBm)` `G` `GibiByte (GiB)` `GigaByte (GB)` `Hour (hs)` `KibiByte (KiB)` `KibiBytePerHour (KiB/h)` `KibiBytePerMinute (KiB/min)` `KibiBytePerSecond (KiB/s)` `KiloByte (kB)` `KiloBytePerHour (kB/h)` `KiloBytePerMinute (kB/min)` `KiloBytePerSecond (kB/s)` `M` `MSU` `MebiByte (MiB)` `MebiBytePerHour (MiB/h)` `MebiBytePerMinute (MiB/min)` `MebiBytePerSecond (MiB/s)` `MegaByte (MB)` `MegaBytePerHour (MB/h)` `MegaBytePerMinute (MB/min)` `MegaBytePerSecond (MB/s)` `MicroSecond (µs)` `MilliSecond (ms)` `MilliSecondPerMinute (ms/min)` `Million (milcount)` `Minute (mins)` `Month (mos)` `N/A` `NanoSecond (ns)` `NanoSecondPerMinute (ns/min)` `PerHour (count/h)` `PerMinute (count/min)` `PerSecond (count/s)` `Percent (%)` `Pixel (px)` `Promille (‰)` `Ratio` `Second (s)` `State` `Unspecified` `Week (ws)` `Year (ys)` `k` `km/h` `m/h` `m/s` `mCores`
filter	string	Функция, из которой берется метрика. Элемент может содержать эти значения `ALL` `BUILTIN` `CUSTOM` `PLUGIN` `REMOTE_PLUGIN`
detailedSource	string	Функция, из которой берется метрика.
pluginId	string	Идентификатор плагина, из которого создается метрика.
types	string []	Определение типа технологии. Используется для группировки метрик под логическим именем технологии.
dataResult	TimeseriesDataPointQueryResult	Список точек данных метрики, а также их параметры.
warnings	string []	Предупреждения, возникшие при создании метрики.

Объект `TimeseriesDataPointQueryResult`

Список точек данных метрики, а также их параметры.

Элемент	Тип	Описание
dataPoints	object	Точки данных метрики. Объект JSON, который сопоставляет идентификатор объекта, предоставившего точки данных, и массив, состоящий из массивов значений с плавающей запятой точек данных. Может содержать более одного идентификатора объекта на запись (например, хост и его сетевой интерфейс). В таких случаях идентификаторы объектов разделяются запятыми. Точка данных содержит значение и отметку времени, когда это значение было записано. АппОптима хранит данные во временных интервалах. Объект dataPoints показывает метку времени начала слота. Если startTimestamp или endTimestamp вашего запроса находится внутри временного интервала данных, этот временной интервал включается в ответ. Из-за того, что временная метка первой точки данных находится за пределами указанного временного интервала, вы увидите более раннюю временную метку, чем указанная начальная временная метка в первой точке данных ответа. Существует три версии точек данных: Числовая точка данных: содержит числовое значение. Точка данных перечисления: содержит значение перечисления, в настоящее время только для временных рядов доступности. Точка данных прогноза: похожа на числовую точку данных, но содержит доверительный интервал, в пределах которого ожидаются будущие значения.
timeseriesId	string	Идентификатор метрики.
unit	string	Единица точек данных. Элемент может содержать эти значения `Billion (bilcount)` `Bit (bit)` `BitPerHour (bit/h)` `BitPerMinute (bit/min)` `BitPerSecond (bit/s)` `Byte (B)` `BytePerHour (B/h)` `BytePerMinute (B/min)` `BytePerSecond (B/s)` `Cores` `Count (count)` `Day (ds)` `DecibelMilliWatt (dBm)` `G` `GibiByte (GiB)` `GigaByte (GB)` `Hour (hs)` `KibiByte (KiB)` `KibiBytePerHour (KiB/h)` `KibiBytePerMinute (KiB/min)` `KibiBytePerSecond (KiB/s)` `KiloByte (kB)` `KiloBytePerHour (kB/h)` `KiloBytePerMinute (kB/min)` `KiloBytePerSecond (kB/s)` `M` `MSU` `MebiByte (MiB)` `MebiBytePerHour (MiB/h)` `MebiBytePerMinute (MiB/min)` `MebiBytePerSecond (MiB/s)` `MegaByte (MB)` `MegaBytePerHour (MB/h)` `MegaBytePerMinute (MB/min)` `MegaBytePerSecond (MB/s)` `MicroSecond (µs)` `MilliSecond (ms)` `MilliSecondPerMinute (ms/min)` `Million (milcount)` `Minute (mins)` `Month (mos)` `N/A` `NanoSecond (ns)` `NanoSecondPerMinute (ns/min)` `PerHour (count/h)` `PerMinute (count/min)` `PerSecond (count/s)` `Percent (%)` `Pixel (px)` `Promille (‰)` `Ratio` `Second (s)` `State` `Unspecified` `Week (ws)` `Year (ys)` `k` `km/h` `m/h` `m/s` `mCores`
resolutionInMillisUTC	integer	Разрешение точек данных.
aggregationType	string	Тип агрегации точек данных. Элемент может содержать эти значения `AVG` `COUNT` `MAX` `MEDIAN` `MIN` `PERCENTILE` `SUM`
entities	object	Список сущностей, из которых исходят точки данных. Объект JSON, который сопоставляет идентификатор объекта в АппОптима и фактическое имя объекта.

JSON-модель тела ответа

<{
  "timeseriesId": "ru.ruscomtech.builtin:host.cpu.idle",
  "displayName": "CPU idle",
  "dimensions": [
    "HOST"
  ],
  "aggregationTypes": [
    "AVG",
    "SUM",
    "MIN",
    "MAX"
  ],
  "unit": "Percent",
  "filter": "BUILTIN",
  "detailedSource": "Infrastructure",
  "types": [],
  "dataResult": {
    "dataPoints": {
      "HOST-0000000000000007": [
        [
          1522220334000,
          89
        ]
      ]
    },
    "timeseriesId": "com.dynatrace.builtin:host.cpu.idle",
    "unit": "Percent",
    "entities": {
      "HOST-0000000000000007": "Laptop-8"
    },
    "resolutionInMillisUTC": 300000,
    "aggregationType": "AVG"
  }
}

Пример

В этом примере запрос запрашивает определение метрики Действия за сеанс (ru.ruscomtech.builtin:app.actionspersession)

Маркер API передается в заголовке авторизации .

Curl

<curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/com.dynatrace.builtin:app.actionspersession?includeData=false \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/ru.ruscomtech.builtin:app.actionspersession?includeData=false

Содержание ответа

<{
  "timeseriesId": "ru.ruscomtech.builtin:app.actionspersession",
  "displayName": "Actions per session",
  "dimensions": [
    "APPLICATION"
  ],
  "unit": "PerMinute (count/min)",
  "detailedSource": "Web application",
  "types": [],
  "aggregationTypes": [
    "AVG"
  ],
  "filter": "BUILTIN"
}

Код ответа

200