Обнаружение аномалий дисковых событий API - GET событие
Получает параметры указанного правила событий диска.
Запрос создает в качестве полезной нагрузки application/json
формат.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id}
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигурации ( ReadConfig
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
id | string | Идентификатор требуемого правила событий диска. | path | требуется |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | DiskEventAnomalyDetectionConfig | Успех |
Объекты тела ответа
Объект DiskEventAnomalyDetectionConfig
Элемент | Тип | Описание |
---|---|---|
metadata | ConfigurationMetadata | Метаданные, полезные для отладки |
id | string | Идентификатор правила события диска. |
name | string | Имя правила событий диска. |
enabled | boolean | Правило событий диска включено/выключено. |
metric | string | Метрика для мониторинга.
Элемент может содержать эти значения
|
threshold | number | Порог для срабатывания дискового события.
|
samples | integer | Количество образцов для оценки. |
violatingSamples | integer | Количество выборок, которые должны нарушить пороговое значение, чтобы вызвать событие. Не должно превышать количество оцениваемых образцов. |
diskNameFilter | DiskNameFilter | Сужает использование правила до дисков, соответствующих указанным критериям. |
tagFilters | TagFilter[] | Сужает использование правила до хостов, соответствующих указанным тегам. |
hostGroupId | string | Сужает использование правила до дисков, которые работают на хостах, которые сами работают в указанной группе хостов. |
Объект ConfigurationMetadata
Метаданные, полезные для отладки
Элемент | Тип | Описание |
---|---|---|
configurationVersions | integer[] | Отсортированный список номеров версий конфигурации. |
currentConfigurationVersions | string[] | Отсортированный список номеров версий конфигурации. |
clusterVersion | string | Версия Ключ-АСТРОМ. |
Объект DiskNameFilter
Сужает использование правила до дисков, соответствующих указанным критериям.
Элемент | Тип | Описание |
---|---|---|
operator | string | Оператор сравнения.
Элемент может содержать эти значения
|
value | string | Значение для сравнения. |
Объект TagFilter
Фильтр контролируемых объектов на основе тегов.
Элемент | Тип | Описание |
---|---|---|
context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
key | string | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
value | string | Значение тега.
Не применимо к пользовательским тегам. |
JSON-модель тела ответа
{
"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"
}
Пример
В этом примере в запросе перечислены параметры пользовательского правила события низкого уровня диска .
Маркер API передается в заголовке авторизации .
Правило имеет следующие параметры:
Curl
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/diskEvents/3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/diskEvents/3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0
Тело ответа
{
"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": []
}
Код ответа
200