Просмотр кода страницы Обнаружение аномалий дисковых событий API - GET событие

Получает параметры указанного правила событий диска.

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигурации ( <code>ReadConfig</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|id
|string
|Идентификатор требуемого правила событий диска.
|path
|требуется
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|DiskEventAnomalyDetectionConfig
|Успех
|}

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

==== Объект <code>DiskEventAnomalyDetectionConfig</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|metadata
|ConfigurationMetadata
|Метаданные, полезные для отладки
|-
|id
|string
|Идентификатор правила события диска.
|-
|name
|string
|Имя правила событий диска.
|-
|enabled
|boolean
|Правило событий диска включено/выключено.
|-
|metric
|string
|Метрика для мониторинга.

Элемент может содержать эти значения

* <code>LOW_DISK_SPACE</code>
* <code>LOW_INODES</code>
* <code>READ_TIME_EXCEEDING</code>
* <code>WRITE_TIME_EXCEEDING</code>
|-
|threshold
|number
|Порог для срабатывания дискового события.

* Процент для <code>LowDiskSpace</code>или <code>LowInodes</code>показателей.
* В миллисекундах для <code>ReadTimeExceeding</code>или <code>WriteTimeExceeding</code>метрик.
|-
|samples
|integer
|Количество образцов для оценки.
|-
|violatingSamples
|integer
|Количество выборок, которые должны нарушить пороговое значение, чтобы вызвать событие. Не должно превышать количество оцениваемых образцов.
|-
|diskNameFilter
|DiskNameFilter
|Сужает использование правила до дисков, соответствующих указанным критериям.
|-
|tagFilters
|TagFilter[]
|Сужает использование правила до хостов, соответствующих указанным тегам.
|-
|hostGroupId
|string
|Сужает использование правила до дисков, которые работают на хостах, которые сами работают в указанной группе хостов.
|}

==== Объект <code>ConfigurationMetadata</code> ====
Метаданные, полезные для отладки
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|configurationVersions
|integer[]
|Отсортированный список номеров версий конфигурации.
|-
|currentConfigurationVersions
|string[]
|Отсортированный список номеров версий конфигурации.
|-
|clusterVersion
|string
|Версия Ключ-АСТРОМ.
|}

==== Объект <code>DiskNameFilter</code> ====
Сужает использование правила до дисков, соответствующих указанным критериям.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|operator
|string
|Оператор сравнения.

Элемент может содержать эти значения

* <code>CONTAINS</code>
* <code>DOES_NOT_CONTAIN</code>
* <code>DOES_NOT_EQUAL</code>
* <code>DOES_NOT_START_WITH</code>
* <code>EQUALS</code>
* <code>STARTS_WITH</code>
|-
|value
|string
|Значение для сравнения.
|}

==== Объект <code>TagFilter</code> ====
Фильтр контролируемых объектов на основе тегов.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это <code>CONTEXTLESS</code>значение.

Элемент может содержать эти значения

* <code>AWS</code>
* <code>AWS_GENERIC</code>
* <code>AZURE</code>
* <code>CLOUD_FOUNDRY</code>
* <code>CONTEXTLESS</code>
* <code>ENVIRONMENT</code>
* <code>GOOGLE_CLOUD</code>
* <code>KUBERNETES</code>
|-
|key
|string
|Ключ тега.

Пользовательские теги имеют значение тега здесь.
|-
|value
|string
|Значение тега.

Не применимо к пользовательским тегам.
|}

=== JSON-модель тела ответа ===
 <code>{
   "metadata": {
     "configurationVersions": [
       4,
       2
     ],
     "currentConfigurationVersions": [
       "1.0.4",
       "1.23"
     ],
     "clusterVersion": "1.192.1"
   },
   "id": "string",
   "name": "string",
   "enabled": true,
   "metric": "LOW_DISK_SPACE",
   "threshold": 1,
   "samples": 10,
   "violatingSamples": 8,
   "diskNameFilter": {
     "operator": "CONTAINS",
     "value": "string"
   },
   "tagFilters": [
     {
       "context": "AWS",
       "key": "string",
       "value": "string"
     }
   ],
   "hostGroupId": "string"
 }</code>

== Пример ==
В этом примере в запросе перечислены параметры пользовательского правила события низкого уровня диска .

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

Правило имеет следующие параметры:

[[Файл:disk2.png]]

==== Curl ====
 <code>curl -X GET \
   <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/diskEvents/3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
 <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/diskEvents/3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0</nowiki></code>

==== Тело ответа ====
 <code>{
   "metadata": {
     "clusterVersion": "1.164.0.20190206-143829",
     "configurationVersions": [
       2
     ]
   },
   "id": "3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0",
   "name": "low disk",
   "enabled": true,
   "metric": "LOW_DISK_SPACE",
   "threshold": 2,
   "samples": 5,
   "violatingSamples": 3,
   "diskNameFilter": null,
   "tagFilters": []
 }</code>

==== Код ответа ====
200