API обнаружения аномалий VMware - PUT конфигурация

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

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

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

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

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
body	VMwareAnomalyDetectionConfig	Тело запроса в формате JSON, содержащее параметры конфигурации обнаружения аномалий VMware.	body	необязательный

Объекты тела запроса

Объект 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	Обнаружение включено ( true) или отключено ( false).	необходимый
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
    }
  }
}

Ответ

Коды ответов

Код	Тип	Описание
204		Успех. Конфигурация обновлена. Ответ не имеет тела.
400	ErrorEnvelope	Неуспешно. Ввод недействителен.

Проверка полезной нагрузки

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

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

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

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

Ответ

Коды ответов

Код	Тип	Описание
204		Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.
400	ErrorEnvelope	Неуспешно. Ввод недействителен.

Пример

В этом примере запрос обновляет конфигурацию обнаружения аномалий для VMware из примера запроса GET . Он изменяет режим хоста ESXi «Обнаружение насыщения ЦП» на «На основе настраиваемых пороговых значений» и устанавливает следующие пороговые значения:

• Оповещение, если загрузка ЦП превышает 90 %
• И готовность ЦП ВМ выше 12 %
• И по крайней мере один пик выше 98 % имел место в 3 из 5 образцов.

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

Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно создайте резервную копию текущей конфигурации с помощью вызова конфигурации обнаружения аномалий GET VMware .

Curl

curl -X PUT \
  https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/vmware \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "esxiHighCpuSaturation": {
    "enabled": true,
    "customThresholds": {
      "cpuUsagePercentage": 90,
      "vmCpuReadyPercentage": 12,
      "cpuPeakPercentage": 98
    }
  },
  "esxiHighMemoryDetection": {
    "enabled": true
  },
  "overloadedStorageDetection": {
    "enabled": true
  },
  "undersizedStorageDetection": {
    "enabled": true
  },
  "slowPhysicalStorageDetection": {
    "enabled": true
  },
  "droppedPacketsDetection": {
    "enabled": true
  },
  "lowDatastoreSpaceDetection": {
    "enabled": true
  }
}
'

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

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

Тело запроса

{
  "esxiHighCpuSaturation": {
    "enabled": true,
    "customThresholds": {
      "cpuUsagePercentage": 90,
      "vmCpuReadyPercentage": 12,
      "cpuPeakPercentage": 98
    }
  },
  "esxiHighMemoryDetection": {
    "enabled": true
  },
  "overloadedStorageDetection": {
    "enabled": true
  },
  "undersizedStorageDetection": {
    "enabled": true
  },
  "slowPhysicalStorageDetection": {
    "enabled": true
  },
  "droppedPacketsDetection": {
    "enabled": true
  },
  "lowDatastoreSpaceDetection": {
    "enabled": true
  }
}

Код ответа

204

Результат

Обновленная конфигурация имеет следующие параметры: