POST точек данных - История изменений

IKuznetsov в 11:40, 29 декабря 2024

2024-12-29T11:40:24Z

← Предыдущая версия		Версия от 11:40, 29 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / Эндпойнты среды / Развёртывание / Таймсерии v1 / Чтение точек данных / POST точек данных'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=POST%20%D0%BB%D0%BE%D0%B3%D0%B0%20%D0%BD%D0%B0%D0%B3%D1%80%D1%83%D0%B7%D0%BA%D0%B8-,%D0%A2%D0%B0%D0%B9%D0%BC%D1%81%D0%B5%D1%80%D0%B8%D0%B8%20v1,-%D0%9F%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D0%BA%D0%B8 Таймсерии v1] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F%20%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D0%BA-,%D0%A7%D1%82%D0%B5%D0%BD%D0%B8%D0%B5%20%D1%82%D0%BE%D1%87%D0%B5%D0%BA%20%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85,-GET%20%D1%82%D0%BE%D1%87%D0%B5%D0%BA%20%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85 Чтение точек данных] / POST точек данных'''''

	Извлекает параметры и точки данных указанной метрики. По сравнению с запросом GET запрос POST предоставляет меньше данных о самой метрике.		Извлекает параметры и точки данных указанной метрики. По сравнению с запросом GET запрос POST предоставляет меньше данных о самой метрике.
Строка 181:		Строка 181:
	"office-linz"		"office-linz"
	]		]
	}~~</code>~~		}
	==Ответ==		==Ответ==
	Результатом является объект JSON, содержащий точки данных и параметры метрик.		Результатом является объект JSON, содержащий точки данных и параметры метрик.
Строка 338:		Строка 338:
	"aggregationType": "AVG"		"aggregationType": "AVG"
	}		}
	}~~</code>~~		}
	==Примечание о таймфрейме==		==Примечание о таймфрейме==
	АппОптима хранит данные во временных интервалах. Объект <code>dataPoints</code>показывает ''начальную'' метку времени слота. Если <code>startTimestamp</code>или <code>endTimestamp</code>вашего запроса попадают в временной интервал данных, этот временной интервал будет включен в ответ. Из-за того, что временная метка первой точки данных лежит за пределами указанного временного интервала, вы увидите более ''раннюю'' временную метку, чем указанная <code>startTimestamp</code>в первой точке данных ответа.		АппОптима хранит данные во временных интервалах. Объект <code>dataPoints</code>показывает ''начальную'' метку времени слота. Если <code>startTimestamp</code>или <code>endTimestamp</code>вашего запроса попадают в временной интервал данных, этот временной интервал будет включен в ответ. Из-за того, что временная метка первой точки данных лежит за пределами указанного временного интервала, вы увидите более ''раннюю'' временную метку, чем указанная <code>startTimestamp</code>в первой точке данных ответа.
Строка 356:		Строка 356:
	"APPLICATION-8E41C8C247910758"		"APPLICATION-8E41C8C247910758"
	]		]
	}'~~</code>~~		}'
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki></code>
Строка 368:		Строка 368:
	"APPLICATION-8E41C8"		"APPLICATION-8E41C8"
	]		]
	}~~</code>~~		}
	====Содержание ответа====		====Содержание ответа====
	<{		<{
Строка 411:		Строка 411:
	"timeseriesId": "ru.ruscomtech.builtin:app.actionspersession"		"timeseriesId": "ru.ruscomtech.builtin:app.actionspersession"
	}		}
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	200		200

IKuznetsov в 10:15, 26 декабря 2024

2024-12-26T10:15:30Z

← Предыдущая версия		Версия от 10:15, 26 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / ~~[[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B\|~~Эндпойнты среды]] / ~~[[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5\|~~Развёртывание]] / Таймсерии v1 / Чтение точек данных / POST точек данных'''''		'''''[[API АппОптима]] / Эндпойнты среды / Развёртывание / Таймсерии v1 / Чтение точек данных / POST точек данных'''''

	Извлекает параметры и точки данных указанной метрики. По сравнению с запросом GET запрос POST предоставляет меньше данных о самой метрике.		Извлекает параметры и точки данных указанной метрики. По сравнению с запросом GET запрос POST предоставляет меньше данных о самой метрике.
Строка 8:		Строка 8:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
	\|-		\|-
Строка 80:		Строка 80:
	\|integer		\|integer
	\|Метка времени начала таймфрейма в миллисекундах UTC.		\|Метка времени начала таймфрейма в миллисекундах UTC.
	Если позже текущего времени, ~~Ключ-АСТРОМ~~ автоматически использует текущее время.		Если позже текущего времени, АппОптима автоматически использует текущее время.

	Срок не должен превышать 6 месяцев.		Срок не должен превышать 6 месяцев.
Строка 123:		Строка 123:
	\|string []		\|string []
	\|Фильтрует запрошенные точки данных по объектам, которые должны их предоставить. Вы можете указать сразу несколько сущностей.		\|Фильтрует запрошенные точки данных по объектам, которые должны их предоставить. Вы можете указать сразу несколько сущностей.
	Допустимые значения — идентификаторы объектов ~~Ключ-АСТРОМ~~.		Допустимые значения — идентификаторы объектов АппОптима.

	Если выбранный объект не поддерживает запрошенную метрику, запрос приведет к ошибке.		Если выбранный объект не поддерживает запрошенную метрику, запрос приведет к ошибке.
Строка 165:		Строка 165:
	===JSON-модель тела запроса===		===JSON-модель тела запроса===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"timeseriesId": "ru.ruscomtech.builtin:host.cpu.idle",		"timeseriesId": "ru.ruscomtech.builtin:host.cpu.idle",
	"aggregationType": "AVG",		"aggregationType": "AVG",
Строка 221:		Строка 221:
	Точка данных содержит значение и отметку времени, когда это значение было записано.		Точка данных содержит значение и отметку времени, когда это значение было записано.

	~~Ключ-АСТРОМ~~ хранит данные во временных интервалах. Объект dataPoints показывает метку времени ''начала'' слота. Если startTimestamp или endTimestamp вашего запроса находится внутри временного интервала данных, этот временной интервал включается в ответ. Из-за того, что временная метка первой точки данных находится за пределами указанного временного интервала, вы увидите ''более раннюю'' временную метку, чем указанная начальная временная метка в первой точке данных ответа.		АппОптима хранит данные во временных интервалах. Объект dataPoints показывает метку времени ''начала'' слота. Если startTimestamp или endTimestamp вашего запроса находится внутри временного интервала данных, этот временной интервал включается в ответ. Из-за того, что временная метка первой точки данных находится за пределами указанного временного интервала, вы увидите ''более раннюю'' временную метку, чем указанная начальная временная метка в первой точке данных ответа.

	Существует три версии точек данных:		Существует три версии точек данных:
Строка 317:		Строка 317:
	\|object		\|object
	\|Список сущностей, из которых исходят точки данных.		\|Список сущностей, из которых исходят точки данных.
	Объект JSON, который сопоставляет идентификатор объекта в ~~Ключ-АСТРОМ~~ и фактическое имя объекта.		Объект JSON, который сопоставляет идентификатор объекта в АппОптима и фактическое имя объекта.
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"result": {		"result": {
	"dataPoints": {		"dataPoints": {
Строка 340:		Строка 340:
	}</code>		}</code>
	==Примечание о таймфрейме==		==Примечание о таймфрейме==
	~~Ключ-АСТРОМ~~ хранит данные во временных интервалах. Объект <code>dataPoints</code>показывает ''начальную'' метку времени слота. Если <code>startTimestamp</code>или <code>endTimestamp</code>вашего запроса попадают в временной интервал данных, этот временной интервал будет включен в ответ. Из-за того, что временная метка первой точки данных лежит за пределами указанного временного интервала, вы увидите более ''раннюю'' временную метку, чем указанная <code>startTimestamp</code>в первой точке данных ответа.		АппОптима хранит данные во временных интервалах. Объект <code>dataPoints</code>показывает ''начальную'' метку времени слота. Если <code>startTimestamp</code>или <code>endTimestamp</code>вашего запроса попадают в временной интервал данных, этот временной интервал будет включен в ответ. Из-за того, что временная метка первой точки данных лежит за пределами указанного временного интервала, вы увидите более ''раннюю'' временную метку, чем указанная <code>startTimestamp</code>в первой точке данных ответа.
	==Пример==		==Пример==
	В этом примере запрос возвращает значения метрики Действия за сеанс ( <code>ru.ruscomtech.builtin:app.actionspersession</code>) за последний час для приложений APPLICATION-85A7CC и APPLICATION-8E41C8 . Результат возвращает среднее количество действий пользователя в приложении. Результат усекается до трех точек данных для каждого приложения.		В этом примере запрос возвращает значения метрики Действия за сеанс ( <code>ru.ruscomtech.builtin:app.actionspersession</code>) за последний час для приложений APPLICATION-85A7CC и APPLICATION-8E41C8 . Результат возвращает среднее количество действий пользователя в приложении. Результат усекается до трех точек данных для каждого приложения.
	====Curl====		====Curl====
	<~~code>~~curl -X POST \		<curl -X POST \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki> \
	-H 'Authorization: abcdefjhij1234567890' \		-H 'Authorization: abcdefjhij1234567890' \
Строка 360:		Строка 360:
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki></code>
	====Тело запроса====		====Тело запроса====
	<~~code>~~{		<{
	"timeseriesId": "ru.ruscomtech.builtin:app.actionspersession",		"timeseriesId": "ru.ruscomtech.builtin:app.actionspersession",
	"relativeTime": "hour",		"relativeTime": "hour",
Строка 370:		Строка 370:
	}</code>		}</code>
	====Содержание ответа====		====Содержание ответа====
	<~~code>~~{		<{
	"result": {		"result": {
	"dataPoints": {		"dataPoints": {

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-28T15:50:26Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

Новая страница

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5|Развёртывание]] / Таймсерии v1 / Чтение точек данных / POST точек данных'''''

Извлекает параметры и точки данных указанной метрики. По сравнению с запросом GET запрос POST предоставляет меньше данных о самой метрике.

Чтобы получить точки данных, необходимо указать период времени и тип агрегации, поддерживаемые запрошенной метрикой.

Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/timeseries/{timeseriesIdentifier}</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
Для получения точек данных необходимо указать таймфрейм и тип агрегации.

Существует два взаимоисключающих способа установки таймфрейма:
*Комбинация startTimestamp и endTimestamp .
*relativeTime
Максимально допустимый срок — 6 месяцев.
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|timeseriesIdentifier
|string
|Идентификатор временного ряда с учетом регистра, из которого вы хотите прочитать параметры и точки данных.
|path
|требуется
|-
|body
|TimeseriesQueryMessage
|Тело запроса JSON, содержащее параметры для определения необходимых точек данных.
|body
|по желанию
|}
===Объекты тела запроса===
====Объект <code>TimeseriesQueryMessage</code>====
Параметры фильтрации для запроса временных рядов.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|timeseriesId
|string
|Идентификатор метрики с учетом регистра, в которой вы хотите считать точки данных.
Вы можете выполнить запрос временных рядов GET, чтобы получить список доступных метрик.
|по желанию
|-
|aggregationType
|string
|Тип агрегации для результирующих точек данных.
Если запрошенная метрика не поддерживает указанную агрегацию, запрос приведет к ошибке.

Элемент может содержать эти значения
*<code>AVG</code>
*<code>COUNT</code>
*<code>MAX</code>
*<code>MEDIAN</code>
*<code>MIN</code>
*<code>PERCENTILE</code>
*<code>SUM</code>
|по желанию
|-
|startTimestamp
|integer
|Метка времени начала таймфрейма в миллисекундах UTC.
|по желанию
|-
|endTimestamp
|integer
|Метка времени начала таймфрейма в миллисекундах UTC.
Если позже текущего времени, Ключ-АСТРОМ автоматически использует текущее время.

Срок не должен превышать 6 месяцев.
|по желанию
|-
|predict
|boolean
|Флаг для прогнозирования будущих точек данных.
|по желанию
|-
|relativeTime
|string
|Относительный таймфрейм, назад от текущего времени.
Элемент может содержать эти значения
*<code>10mins</code>
*<code>15mins</code>
*<code>2hours</code>
*<code>30mins</code>
*<code>3days</code>
*<code>5mins</code>
*<code>6hours</code>
*<code>day</code>
*<code>hour</code>
*<code>min</code>
*<code>month</code>
*<code>week</code>
|по желанию
|-
|queryMode
|string
|Определяет тип результата, который должен возвращать вызов. Допустимые режимы результатов:
<code>series</code>: возвращает все точки данных метрики за указанный период времени. <code>total</code>: возвращает одно скалярное значение для указанного периода времени.

По умолчанию используется <code>series</code>режим.

Элемент может содержать эти значения
*<code>SERIES</code>
*<code>TOTAL</code>
|по желанию
|-
|entities
|string []
|Фильтрует запрошенные точки данных по объектам, которые должны их предоставить. Вы можете указать сразу несколько сущностей.
Допустимые значения — идентификаторы объектов Ключ-АСТРОМ.

Если выбранный объект не поддерживает запрошенную метрику, запрос приведет к ошибке.
|по желанию
|-
|tags
|string []
|Фильтрует запрошенные точки данных по объекту, который должен их предоставить. Доставляются данные только от сущностей с указанным тегом.
Вы можете указать несколько тегов в следующем формате: <code>tags=tag1&tags=tag2</code>. Сущность должна соответствовать ''всем'' указанным тегам.

В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: <code>[context]key:value</code>.
|по желанию
|-
|filters
|object
|Фильтр — это объект, содержащий карту ключей фильтра и его значений. Действительные ключи фильтра:
<code>processType</code>: фильтрует по типу процесса. Допустимые значения см. в разделе Типы процессов. <code>osType</code>: фильтрация по операционной системе. Допустимые значения см. в разделе Типы ОС. <code>serviceType</code>: фильтрация по типу службы. Допустимые значения см. в разделе Типы служб. <code>technology</code>: фильтрация по типу технологии. Допустимые значения см. в разделе Типы технологий. <code>webServiceName</code>: фильтрация по имени веб-службы. <code>webServiceNamespace</code>: фильтрация по пространству имен веб-службы. <code>host</code>: Фильтрация по идентификатору хоста, например HOST-007.
|по желанию
|-
|percentile
|integer
|Указывает, какой процентиль выбранной метрики времени отклика должен быть предоставлен.
Применимо только к <code>PERCENTILE</code>типу агрегации.

Допустимые значения для процентиля находятся в диапазоне от 1 до 99.

Имейте в виду, что экспорт процентилей возможен только для метрик, основанных на времени отклика, таких как время отклика приложений и служб.
|по желанию
|-
|includeParentIds
|boolean
|Указывает, должны ли результаты отображать сопоставления измерений между родительскими объектами и их дочерними объектами.
Например: SERVICE-0000000000000001, SERVICE_METHOD-0000000000000001
|по желанию
|-
|considerMaintenanceWindowsForAvailability
|boolean
|Исключите ( <code>true</code>) или включите ( <code>false</code>) точки данных из любого периода обслуживания , определенного в вашей среде.
|по желанию
|}
===JSON-модель тела запроса===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"timeseriesId": "ru.ruscomtech.builtin:host.cpu.idle",
"aggregationType": "AVG",
"startTimestamp": 1521042929000,
"endTimestamp": 1521542929000,
"predict": true,
"relativeTime": "HOUR",
"queryMode": "SERIES",
"includeParentIds": "false",
"considerMaintenanceWindowsForAvailability": "false",
"entities": [
"HOST-0000000000000007"
],
"tags": [
"office-linz"
]
}</code>
==Ответ==
Результатом является объект JSON, содержащий точки данных и параметры метрик.
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|TimeseriesQueryResultWrapper
|Успех
|}
===Объекты тела ответа===
====Объект <code>TimeseriesQueryResultWrapper</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|result
|TimeseriesDataPointQueryResult
|Список точек данных метрики, а также их параметры.
|}
====Объект <code>TimeseriesDataPointQueryResult</code>====
Список точек данных метрики, а также их параметры.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|dataPoints
|object
|Точки данных метрики.
Объект JSON, который сопоставляет идентификатор объекта, предоставившего точки данных, и массив, состоящий из массивов значений с плавающей запятой точек данных.

Может содержать более одного идентификатора объекта на запись (например, хост и его сетевой интерфейс). В таких случаях идентификаторы объектов разделяются запятыми.

Точка данных содержит значение и отметку времени, когда это значение было записано.

Ключ-АСТРОМ хранит данные во временных интервалах. Объект dataPoints показывает метку времени ''начала'' слота. Если startTimestamp или endTimestamp вашего запроса находится внутри временного интервала данных, этот временной интервал включается в ответ. Из-за того, что временная метка первой точки данных находится за пределами указанного временного интервала, вы увидите ''более раннюю'' временную метку, чем указанная начальная временная метка в первой точке данных ответа.

Существует три версии точек данных:
*Числовая точка данных: содержит числовое значение.
*Точка данных перечисления: содержит значение перечисления, в настоящее время только для временных рядов доступности.
*Точка данных прогноза: похожа на числовую точку данных, но содержит доверительный интервал, в пределах которого ожидаются будущие значения.
|-
|timeseriesId
|string
|Идентификатор метрики.
|-
|unit
|string
|Единица точек данных.
Элемент может содержать эти значения
*<code>Billion (bilcount)</code>
*<code>Bit (bit)</code>
*<code>BitPerHour (bit/h)</code>
*<code>BitPerMinute (bit/min)</code>
*<code>BitPerSecond (bit/s)</code>
*<code>Byte (B)</code>
*<code>BytePerHour (B/h)</code>
*<code>BytePerMinute (B/min)</code>
*<code>BytePerSecond (B/s)</code>
*<code>Cores</code>
*<code>Count (count)</code>
*<code>Day (ds)</code>
*<code>DecibelMilliWatt (dBm)</code>
*<code>G</code>
*<code>GibiByte (GiB)</code>
*<code>GigaByte (GB)</code>
*<code>Hour (hs)</code>
*<code>KibiByte (KiB)</code>
*<code>KibiBytePerHour (KiB/h)</code>
*<code>KibiBytePerMinute (KiB/min)</code>
*<code>KibiBytePerSecond (KiB/s)</code>
*<code>KiloByte (kB)</code>
*<code>KiloBytePerHour (kB/h)</code>
*<code>KiloBytePerMinute (kB/min)</code>
*<code>KiloBytePerSecond (kB/s)</code>
*<code>M</code>
*<code>MSU</code>
*<code>MebiByte (MiB)</code>
*<code>MebiBytePerHour (MiB/h)</code>
*<code>MebiBytePerMinute (MiB/min)</code>
*<code>MebiBytePerSecond (MiB/s)</code>
*<code>MegaByte (MB)</code>
*<code>MegaBytePerHour (MB/h)</code>
*<code>MegaBytePerMinute (MB/min)</code>
*<code>MegaBytePerSecond (MB/s)</code>
*<code>MicroSecond (µs)</code>
*<code>MilliSecond (ms)</code>
*<code>MilliSecondPerMinute (ms/min)</code>
*<code>Million (milcount)</code>
*<code>Minute (mins)</code>
*<code>Month (mos)</code>
*<code>N/A</code>
*<code>NanoSecond (ns)</code>
*<code>NanoSecondPerMinute (ns/min)</code>
*<code>PerHour (count/h)</code>
*<code>PerMinute (count/min)</code>
*<code>PerSecond (count/s)</code>
*<code>Percent (%)</code>
*<code>Pixel (px)</code>
*<code>Promille (‰)</code>
*<code>Ratio</code>
*<code>Second (s)</code>
*<code>State</code>
*<code>Unspecified</code>
*<code>Week (ws)</code>
*<code>Year (ys)</code>
*<code>k</code>
*<code>km/h</code>
*<code>m/h</code>
*<code>m/s</code>
*<code>mCores</code>
|-
|resolutionInMillisUTC
|integer
|Разрешение точек данных.
|-
|aggregationType
|string
|Тип агрегации точек данных.
Элемент может содержать эти значения
*<code>AVG</code>
*<code>COUNT</code>
*<code>MAX</code>
*<code>MEDIAN</code>
*<code>MIN</code>
*<code>PERCENTILE</code>
*<code>SUM</code>
|-
|entities
|object
|Список сущностей, из которых исходят точки данных.
Объект JSON, который сопоставляет идентификатор объекта в Ключ-АСТРОМ и фактическое имя объекта.
|}
===JSON-модель тела ответа===
<code>{
"result": {
"dataPoints": {
"HOST-0000000000000007": [
[
1522220334000,
89
]
]
},
"timeseriesId": "ru.ruscomtech.builtin:host.cpu.idle",
"unit": "Percent",
"entities": {
"HOST-0000000000000007": "Laptop-8"
},
"resolutionInMillisUTC": 300000,
"aggregationType": "AVG"
}
}</code>
==Примечание о таймфрейме==
Ключ-АСТРОМ хранит данные во временных интервалах. Объект <code>dataPoints</code>показывает ''начальную'' метку времени слота. Если <code>startTimestamp</code>или <code>endTimestamp</code>вашего запроса попадают в временной интервал данных, этот временной интервал будет включен в ответ. Из-за того, что временная метка первой точки данных лежит за пределами указанного временного интервала, вы увидите более ''раннюю'' временную метку, чем указанная <code>startTimestamp</code>в первой точке данных ответа.
==Пример==
В этом примере запрос возвращает значения метрики Действия за сеанс ( <code>ru.ruscomtech.builtin:app.actionspersession</code>) за последний час для приложений APPLICATION-85A7CC и APPLICATION-8E41C8 . Результат возвращает среднее количество действий пользователя в приложении. Результат усекается до трех точек данных для каждого приложения.
====Curl====
<code>curl -X POST \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki> \
-H 'Authorization: abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"timeseriesId": "ru.ruscomtech.builtin:app.actionspersession",
"relativeTime": "hour",
"aggregationType": "avg",
"entities": [
"APPLICATION-85A7CCAAC7345F0B",
"APPLICATION-8E41C8C247910758"
]
}'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries</nowiki></code>
====Тело запроса====
<code>{
"timeseriesId": "ru.ruscomtech.builtin:app.actionspersession",
"relativeTime": "hour",
"aggregationType": "avg",
"entities": [
"APPLICATION-85A7CC",
"APPLICATION-8E41C8"
]
}</code>
====Содержание ответа====
<code>{
"result": {
"dataPoints": {
"APPLICATION-85A7CC": [
[
1534920000000,
1.6666666666666667
],
[
1534920060000,
2.5
],
[
1534920120000,
2.888888888888889
]
],
"APPLICATION-8E41C8": [
[
1534920000000,
null
],
[
1534920060000,
3
],
[
1534920120000,
null
]
]
},
"unit": "PerMinute (count/min)",
"resolutionInMillisUTC": 60000,
"aggregationType": "AVG",
"entities": {
"APPLICATION-85A7CC": "Permanent Docker",
"APPLICATION-8E41C8": "easyTravel AMP"
},
"timeseriesId": "ru.ruscomtech.builtin:app.actionspersession"
}
}</code>
====Код ответа====
200