API обнаружения аномалий VMware - GET конфигурация: различия между версиями

Версия 17:10, 9 марта 2023

Получает конфигурацию обнаружения аномалий для VMware.

Запрос создает в качестве полезной нагрузки application/json формат.

GET	Ключ-АСТРОМ Managed для управления	`https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware`

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. ReadConfig

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код	Тип	Описание
200	Конфигурация обнаружения аномалий V Mware	Успех

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

Объект `VMwareAnomalyDetectionConfig`

Конфигурация обнаружения аномалий для VMware.

Элемент	Тип	Описание
metadata	ConfigurationMetadata	Метаданные, полезные для отладки
esxiHighCpuSaturation	EsxiHighCpuSaturationConfig	Конфигурация загрузки ЦП при обнаружении хоста ESXi.
guestCpuLimitReached	GuestCPULimitReachedConfig	Конфигурация предела гостевого ЦП достигла обнаружения конфигурации.
esxiHighMemoryDetection	EsxiHighMemoryDetectionConfig	Конфигурация насыщения памяти при обнаружении хоста ESXi.
overloadedStorageDetection	OverloadedStorageDetectionConfig	Конфигурация перегруженного хранилища при обнаружении физического устройства хранения.
undersizedStorageDetection	UndersizedStorageDetectionConfig	Обнаружение устройства хранения меньшего размера
slowPhysicalStorageDetection	SlowPhysicalStorageDetectionConfig	Конфигурация физического устройства хранения работает с медленным обнаружением.
droppedPacketsDetection	DroppedPacketsDetectionConfig	Конфигурация обнаружения большого количества потерянных пакетов.
lowDatastoreSpaceDetection	LowDatastoreSpaceDetectionConfig	Конфигурация обнаружения нехватки свободного места в хранилище данных.

Объект `ConfigurationMetadata`

Метаданные, полезные для отладки

Элемент	Тип	Описание
configurationVersions	integer[]	Отсортированный список номеров версий конфигурации.
currentConfigurationVersions	string[]	Отсортированный список номеров версий конфигурации.
clusterVersion	string	Версия Ключ-АСТРОМ.

Объект `EsxiHighCpuSaturationConfig`

Конфигурация загрузки ЦП при обнаружении хоста ESXi.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	EsxiHighCpuThresholds	Пользовательские пороги для обнаружения насыщения ЦП на ESXi. Если не установлено, то используется автоматический режим. Для срабатывания оповещения должны быть выполнены все условия.

Объект `EsxiHighCpuThresholds`

Пользовательские пороги для обнаружения насыщения ЦП на ESXi. Если не установлено, то используется автоматический режим.

Для срабатывания оповещения должны быть выполнены все условия.

Элемент	Тип	Описание
cpuUsagePercentage	integer	Использование ЦП выше, чем X % в 3 из 5 образцов.
vmCpuReadyPercentage	integer	Готовность ЦП ВМ выше, чем X % в 3 из 5 образцов.
cpuPeakPercentage	integer	По крайней мере, один пик выше X % имел место в 3 из 5 образцов.

Объект `GuestCPULimitReachedConfig`

Конфигурация предела гостевого ЦП достигла обнаружения конфигурации.

Элемент	Тип	Описание
enabled	boolean
customThresholds	GuestCPULimitThresholds	Пользовательские пороговые значения для определения предела гостевого процессора. Если не установлено, то используется автоматический режим. Для срабатывания оповещения должны быть выполнены все условия.

Объект `GuestCPULimitThresholds`

Пользовательские пороговые значения для определения предела гостевого процессора. Если не установлено, то используется автоматический режим.

Для срабатывания оповещения должны быть выполнены все условия.

Элемент	Тип	Описание
hostCpuUsageMinPercentage	integer	Использование ЦП гипервизора превышает X % в 3 из 5 образцов.
vmCpuUsageMaxPercentage	integer	Загрузка ЦП ВМ (использование ЦП ВМ, МГц / ограничение ЦП ВМ в МГц) превышает X % в 3 из 5 образцов.
VMCpuReadyMaxPercentage	integer	Готовность ЦП ВМ выше, чем X % в 3 из 5 выборок.

Объект `EsxiHighMemoryDetectionConfig`

Конфигурация насыщения памяти при обнаружении хоста ESXi.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	EsxiHighMemoryThresholds	Пользовательские пороги насыщения памяти на хосте ESXi. Если не установлено, то используется автоматический режим.

Объект `EsxiHighMemoryThresholds`

Пользовательские пороги насыщения памяти на хосте ESXi. Если не установлено, то используется автоматический режим.

Элемент	Тип	Описание
compressionDecompressionRate	number	Предупреждать, если хост ESXi перекачивает IN/OUT или скорость сжатия/распаковки выше X килобайт в секунду в 3 из 5 выборок.

Объект `OverloadedStorageDetectionConfig`

Конфигурация перегруженного хранилища при обнаружении физического устройства хранения.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	OverloadedStorageThresholds	Пользовательские пороги для перегруженного хранилища на физическом устройстве хранения. Если не установлено, то используется автоматический режим.

Объект `OverloadedStorageThresholds`

Пользовательские пороги для перегруженного хранилища на физическом устройстве хранения. Если не установлено, то используется автоматический режим.

Элемент	Тип	Описание
commandAbortsNumber	integer	Оповещение, если количество прерываний команды превышает X в 3 из 5 выборок.

Объект `UndersizedStorageDetectionConfig`

Обнаружение устройства хранения меньшего размера

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	UndersizedStorageThresholds	Пользовательские пороги для устройства хранения меньшего размера. Если не установлено, то используется автоматический режим. Выполнение любого условия вызывает оповещение.

Объект `UndersizedStorageThresholds`

Пользовательские пороги для устройства хранения меньшего размера. Если не установлено, то используется автоматический режим.

Выполнение любого условия вызывает оповещение.

Элемент	Тип	Описание
averageQueueCommandLatency	integer	Средняя задержка команды очереди превышает X миллисекунд в 3 из 5 образцов.
peakQueueCommandLatency	integer	Пиковая задержка команды очереди превышает X миллисекунд в 3 из 5 образцов.

Объект `SlowPhysicalStorageDetectionConfig`

Конфигурация физического устройства хранения работает с медленным обнаружением.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	SlowPhysicalStorageThresholds	Пользовательские пороги для медленно работающего физического устройства хранения. Если не установлено, то используется автоматический режим. Выполнение любого условия вызывает оповещение.

Объект `SlowPhysicalStorageThresholds`

Пользовательские пороги для медленно работающего физического устройства хранения. Если не установлено, то используется автоматический режим.

Выполнение любого условия вызывает оповещение.

Элемент	Тип	Описание
avgReadWriteLatency	integer	Задержка чтения/записи превышает X миллисекунд в 4 из 5 образцов.
peakReadWriteLatency	integer	Пиковое значение задержки чтения/записи превышает X миллисекунд в 4 из 5 выборок.

Объект `DroppedPacketsDetectionConfig`

Конфигурация обнаружения большого количества потерянных пакетов.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	DroppedPacketsThresholds	Пользовательские пороги для большого количества потерянных пакетов. Если не установлено, то используется автоматический режим.

Объект `DroppedPacketsThresholds`

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

Элемент	Тип	Описание
dropPacketsPerSecond	integer	Предупреждать, если скорость приема/передачи отброшенных пакетов на сетевом адаптере превышает X пакетов в секунду в 3 из 5 выборок.

Объект `LowDatastoreSpaceDetectionConfig`

Конфигурация обнаружения нехватки свободного места в хранилище данных.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	LowDatastoreSpaceThresholds	Пользовательские пороги для низкого свободного места в хранилище данных. Если не установлено, то используется автоматический режим.

Объект `LowDatastoreSpaceThresholds`

Пользовательские пороги для низкого свободного места в хранилище данных. Если не установлено, то используется автоматический режим.

Элемент	Тип	Описание
freeSpacePercentage	integer	Предупреждать, если свободного места в хранилище данных меньше X %.

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

{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "clusterVersion": "Mock version"
  },
  "esxiHighCpuSaturation": {
    "enabled": true,
    "customThresholds": {
      "cpuUsagePercentage": 80,
      "vmCpuReadyPercentage": 10,
      "cpuPeakPercentage": 90
    }
  },
  "esxiHighMemoryDetection": {
    "enabled": true,
    "customThresholds": {
      "compressionDecompressionRate": 120
    }
  },
  "overloadedStorageDetection": {
    "enabled": true,
    "customThresholds": {
      "commandAbortsNumber": 1
    }
  },
  "undersizedStorageDetection": {
    "enabled": true,
    "customThresholds": {
      "averageQueueCommandLatency": 15,
      "peakQueueCommandLatency": 160
    }
  },
  "slowPhysicalStorageDetection": {
    "enabled": true,
    "customThresholds": {
      "avgReadWriteLatency": 150,
      "peakReadWriteLatency": 400
    }
  },
  "droppedPacketsDetection": {
    "enabled": true,
    "customThresholds": {
      "droppedPacketsPerSecond": 4
    }
  },
  "lowDatastoreSpaceDetection": {
    "enabled": true,
    "customThresholds": {
      "freeSpacePercentage": 5
    }
  }
}

Пример

В этом примере в запросе указана текущая конфигурация обнаружения аномалий для VMware.

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

Конфигурация имеет следующие настройки:

Curl

curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/vmware \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/vmware

Тело ответа

{
  "metadata": {
    "clusterVersion": "1.164.0.20190204-124711",
    "configurationVersions": [
      1
    ]
  },
  "esxiHighCpuSaturation": {
    "enabled": true
  },
  "esxiHighMemoryDetection": {
    "enabled": true
  },
  "overloadedStorageDetection": {
    "enabled": true
  },
  "undersizedStorageDetection": {
    "enabled": true
  },
  "slowPhysicalStorageDetection": {
    "enabled": true
  },
  "droppedPacketsDetection": {
    "enabled": true
  },
  "lowDatastoreSpaceDetection": {
    "enabled": true
  }
}

Код ответа

200

@@ Строка 78: / Строка 78: @@
 |}
-==== Объект _ <code>ConfigurationMetadata</code> ====
+==== Объект <code>ConfigurationMetadata</code> ====
 Метаданные, полезные для отладки
 {| class="wikitable"

Аноним

Поиск

API обнаружения аномалий VMware - GET конфигурация: различия между версиями

Версия 17:10, 9 марта 2023

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

Параметры

Ответ

Коды ответов

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

Объект VMwareAnomalyDetectionConfig

Объект ConfigurationMetadata

Объект EsxiHighCpuSaturationConfig

Объект EsxiHighCpuThresholds

Объект GuestCPULimitReachedConfig

Объект GuestCPULimitThresholds

Объект EsxiHighMemoryDetectionConfig

Объект EsxiHighMemoryThresholds

Объект OverloadedStorageDetectionConfig

Объект OverloadedStorageThresholds

Объект UndersizedStorageDetectionConfig

Объект UndersizedStorageThresholds

Объект SlowPhysicalStorageDetectionConfig

Объект SlowPhysicalStorageThresholds

Объект DroppedPacketsDetectionConfig

Объект DroppedPacketsThresholds

Объект LowDatastoreSpaceDetectionConfig

Объект LowDatastoreSpaceThresholds