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-27T18:51:37Z

Новая страница: «'''''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|Развёртывание]] / Расширения 2.0 / Таймсерии v1 / [https://doc.ruscomtech.ru/index.php/%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_%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D0%BA%D0%B8 Пользовательские метрики] / PUT пользовательской метрики'''''

Регистрирует вашу пользовательскую метрику. Вам необходимо указать идентификатор, отображаемое имя и тип метрики.

Если вы используете идентификатор существующей метрики, соответствующие параметры будут обновлены.

Запрос потребляет и создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |PUT
|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)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|timeseriesIdentifier
|string
|Идентификатор новой метрики. Он должен начинаться с <code>custom:</code>префикса.
Вы можете использовать буквенно-цифровые символы и следующие знаки препинания: точки ( <code>.</code>), дефисы ( <code>-</code>) и запятые ( <code>,</code>). Число не может следовать за знаком препинания.

Если вы используете идентификатор существующей метрики, соответствующие параметры будут обновлены.

Длина идентификатора ограничена 256 символами .
|path
|требуется
|-
|body
|TimeseriesRegistrationMessage
|Тело JSON запроса. Содержит параметры новой пользовательской метрики.
|body
|по желанию
|}
===Объекты тела запроса===
====Объект <code>TimeseriesRegistrationMessage</code>====
Определение пользовательской метрики.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|displayName
|string
|Имя показателя, которое будет отображаться в пользовательском интерфейсе. Он ограничен 256 символами.
Чтобы изменить значение этого поля, вам необходимо разрешение « Запись конфигурации » ( <code>WriteConfig</code>) или « Запись настроек » ( <code>settings.write</code>), назначенное вашему токену API.
|по желанию
|-
|unit
|string
|Единица, которую будет использовать метрика.
Чтобы изменить значение этого поля, вам необходимо разрешение « Запись конфигурации » ( <code>WriteConfig</code>) или « Запись настроек » ( <code>settings.write</code>), назначенное вашему токену API.

Элемент может содержать эти значения
*<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>
|по желанию
|-
|dimensions
|string[]
|Ключ параметра метрики, который будет использоваться для отчета по нескольким параметрам. Например, ключ измерения для отчета о метрике для разных сетевых карт для одного и того же брандмауэра.
Вы можете использовать буквенно-цифровые символы и следующие знаки препинания: точки ( <code>.</code>), дефисы ( <code>-</code>) и символы подчеркивания ( <code>_</code>).

Параметр CUSTOM_DEVICE автоматически добавляется к каждому новому пользовательскому показателю.

Длина ключей и значений размеров ограничена 128 символами каждый.
|по желанию
|-
|types
|string []
|Определение типа техники. Он используется для группировки метрик под логическим именем технологии в пользовательском интерфейсе.
Метрикам должен быть назначен тип программной технологии, идентичный типу технологии пользовательского устройства, на которое вы отправляете метрику.

Например, если вы определяете свое пользовательское устройство с помощью типа <code>F5-Firewall</code>, вы также должны зарегистрировать все связанные с ним пользовательские показатели как тип <code>F5-Firewall</code>.

Поле обязательно для заполнения при создании новой метрики.
|по желанию
|}
===JSON-модель тела запроса===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"displayName": "received.coffees",
"unit": "Count",
"dimensions": [
"coffee"
],
"types": [
"coffee machine"
]
}</code>
==Ответ==
Результатом является JSON, содержащий метаданные вновь созданной метрики.
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|201
|TimeseriesDefinition
|Успех. Пользовательский показатель создан.
|}
===Объекты тела ответа===
====Объект <code>TimeseriesDefinition</code>====
Конфигурация метрики со всеми ее параметрами.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|timeseriesId
|string
|Идентификатор метрики.
|-
|displayName
|string
|Имя метрики в пользовательском интерфейсе.
|-
|dimensions
|string[]
|Точное разделение метрик, например, группа процессов и идентификатор процесса для какой-либо метрики, связанной с процессом.
|-
|aggregationTypes
|string[]
|Список разрешенных агрегаций для этой метрики.
Элемент может содержать эти значения
*<code>AVG</code>
*<code>COUNT</code>
*<code>MAX</code>
*<code>MEDIAN</code>
*<code>MIN</code>
*<code>PERCENTILE</code>
*<code>SUM</code>
|-
|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>
|-
|filter
|string
|Функция, из которой берется метрика.
Элемент может содержать эти значения
*<code>ALL</code>
*<code>BUILTIN</code>
*<code>CUSTOM</code>
*<code>PLUGIN</code>
*<code>REMOTE_PLUGIN</code>
|-
|detailedSource
|string
|Функция, из которой берется метрика.
|-
|pluginId
|string
|Идентификатор плагина, из которого создается метрика.
|-
|types
|string []
|Определение типа технологии. Используется для группировки метрик под логическим именем технологии.
|-
|warnings
|string []
|Предупреждения, возникшие при создании метрики.
|}
===JSON-модель тела ответа===
<code>{
"timeseriesId": "com.ruscomtech.builting:host.cpu.idle",
"displayName": "CPU idle",
"dimensions": [
"HOST"
],
"aggregationTypes": [
"AVG",
"SUM",
"MIN",
"MAX"
],
"unit": "Percent",
"filter": "BUILTIN",
"detailedSource": "Infrastructure",
"types": [
"Test"
],
"warnings": []
}</code>
==Пример==
В этом примере запрос создает новую пользовательскую метрику с <code>custom:firewall.connections.dropped</code>идентификатором <code>F5-Firewall</code>типа. Его единица <code>count</code>. <code>nic</code>Ключ измерения используется для отчета о метрике для разных сетевых карт для одного и того же брандмауэра .

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

Запрос возвращает параметры вновь созданной метрики в качестве подтверждения.
====Curl====
<code>curl -X PUT \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/custom:firewall.connections.dropped</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"displayName"a: "Dropped TCP connections",
"unit"u: "Count",
"dimensions": [
"nic"
],
"types": [
"F5-Firewall"
]
}'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/timeseries/custom:firewall.connections.dropped</nowiki></code>
====Тело запроса====
<code>{
"displayName" : "Dropped TCP connections",
"unit" : "Count",
"dimensions": [
"nic"
],
"types": [
"F5-Firewall"
]
}</code>
====Тело ответа====
<code>{
"timeseriesId": "custom:firewall.connections.dropped",
"displayName": "Dropped TCP connections",
"dimensions": [
"CUSTOM_DEVICE",
"nic"
],
"unit": "Count (count)",
"detailedSource": "API",
"types": [
"F5-Firewall"
],
"aggregationTypes": [
"AVG",
"SUM",
"MIN",
"MAX"
],
"filter": "CUSTOM"
}</code>
====Код ответа====
201

PUT пользовательской метрики - История изменений

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|Эндп...»