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

IKuznetsov в 17:50, 2 января 2025

2025-01-02T17:50:17Z

← Предыдущая версия		Версия от 17:50, 2 января 2025
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты конфигурации]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%9E%D0%B1%D0%BD%D0%B0%D1%80%D1%83%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%B0%D0%BD%D0%BE%D0%BC%D0%B0%D0%BB%D0%B8%D0%B9 Обнаружение аномалий] / [[API обнаружения аномалий - VMware\|VMware]] / PUT конфигурация'''''

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

Строка 477:		Строка 479:
	}		}
	}		}
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 575:		Строка 577:
	}		}
	}		}
	'~~</code>~~		'

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 608:		Строка 610:
	"enabled": true		"enabled": true
	}		}
	}~~</code>~~		}

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

IKuznetsov в 09:41, 26 декабря 2024

2024-12-26T09:41:21Z

← Предыдущая версия		Версия от 09:41, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|PUT		\| rowspan="2" \|PUT
	\|~~Ключ-АСТРОМ Managed~~ для управления		\|АппОптима для управления
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware</nowiki></code>
	\|-		\|-
Строка 107:		Строка 107:
	\|clusterVersion		\|clusterVersion
	\|string		\|string
	\|Версия ~~Ключ-АСТРОМ~~.		\|Версия АппОптима.
	\|необязательный		\|необязательный
	\|}		\|}
Строка 423:		Строка 423:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"metadata": {		"metadata": {
	"configurationVersions": [		"configurationVersions": [
Строка 502:		Строка 502:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|POST		\| rowspan="2" \|POST
	\|~~Ключ-АСТРОМ~~ для управления		\|АппОптима для управления
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware/validator</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware/validator</nowiki></code>
	\|-		\|-
Строка 543:		Строка 543:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X PUT \		<curl -X PUT \
	<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/vmware</nowiki> \		<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/vmware</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
Строка 581:		Строка 581:

	==== Тело запроса ====		==== Тело запроса ====
	<~~code>~~{		<{
	"esxiHighCpuSaturation": {		"esxiHighCpuSaturation": {
	"enabled": true,		"enabled": true,

ENetrebin: /* Объект LowDatastoreSpaceThresholds */

2023-05-04T18:05:16Z

Объект LowDatastoreSpaceThresholds

← Предыдущая версия		Версия от 18:05, 4 мая 2023
Строка 417:		Строка 417:
	\|freeSpacePercentage		\|freeSpacePercentage
	\|integer		\|integer
	\|~~Предупреждать~~, если свободного места в хранилище данных меньше ''X'' %.		\|Предупреждение, если свободного места в хранилище данных меньше ''X'' %.
	\|необходимый		\|необходимый
	\|}		\|}

ENetrebin: Новая страница: «Обновляет конфигурацию обнаружения аномалий для VMware. Запрос использует в качестве поле...»

2023-03-09T18:42:25Z

Новая страница: «Обновляет конфигурацию обнаружения аномалий для VMware. Запрос использует в качестве поле...»

Новая страница

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

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

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>WriteConfig</code>

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

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

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

==== Объект <code>VMwareAnomalyDetectionConfig</code> ====
Конфигурация обнаружения аномалий для VMware.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|metadata
|ConfigurationMetadata
|Метаданные, полезные для отладки
|необязательный
|-
|esxiHighCpuSaturation
|EsxiHighCpuSaturationConfig
|Конфигурация загрузки ЦП при обнаружении хоста ESXi.
|необходимый
|-
|guestCpuLimitReached
|GuestCPULimitReachedConfig
|Конфигурация предела гостевого ЦП достигла обнаружения конфигурации.
|необязательный
|-
|esxiHighMemoryDetection
|EsxiHighMemoryDetectionConfig
|Конфигурация насыщения памяти при обнаружении хоста ESXi.
|необходимый
|-
|overloadedStorageDetection
|OverloadedStorageDetectionConfig
|Конфигурация перегруженного хранилища при обнаружении физического устройства хранения.
|необходимый
|-
|undersizedStorageDetection
|UndersizedStorageDetectionConfig
|Обнаружение устройства хранения меньшего размера
|необходимый
|-
|slowPhysicalStorageDetection
|SlowPhysicalStorageDetectionConfig
|Конфигурация физического устройства хранения работает с медленным обнаружением.
|необходимый
|-
|droppedPacketsDetection
|DroppedPacketsDetectionConfig
|Конфигурация обнаружения большого количества потерянных пакетов.
|необходимый
|-
|lowDatastoreSpaceDetection
|LowDatastoreSpaceDetectionConfig
|Конфигурация обнаружения нехватки свободного места в хранилище данных.
|необходимый
|}

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

==== Объект <code>EsxiHighCpuSaturationConfig</code> ====
Конфигурация загрузки ЦП при обнаружении хоста ESXi.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|EsxiHighCpuThresholds
|Пользовательские пороги для обнаружения насыщения ЦП на ESXi. Если не установлено, то используется автоматический режим.

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

==== Объект <code>EsxiHighCpuThresholds</code> ====
Пользовательские пороги для обнаружения насыщения ЦП на ESXi. Если не установлено, то используется автоматический режим.

Для срабатывания оповещения должны быть выполнены все условия.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|cpuUsagePercentage
|integer
|Использование ЦП выше, чем ''X'' % в 3 из 5 образцов.
|необходимый
|-
|vmCpuReadyPercentage
|integer
|Готовность ЦП ВМ выше, чем ''X'' % в 3 из 5 образцов.
|необходимый
|-
|cpuPeakPercentage
|integer
|По крайней мере, один пик выше ''X'' % имел место в 3 из 5 образцов.
|необходимый
|}

==== Объект <code>GuestCPULimitReachedConfig</code> ====
Конфигурация предела гостевого ЦП достигла обнаружения конфигурации.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|GuestCPULimitThresholds
|Пользовательские пороговые значения для определения предела гостевого процессора. Если не установлено, то используется автоматический режим.

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

==== Объект <code>GuestCPULimitThresholds</code> ====
Пользовательские пороговые значения для определения предела гостевого процессора. Если не установлено, то используется автоматический режим.

Для срабатывания оповещения должны быть выполнены все условия.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|hostCpuUsageMinPercentage
|integer
|Использование ЦП гипервизора превышает ''X'' % в 3 из 5 образцов.
|необходимый
|-
|vmCpuUsageMaxPercentage
|integer
|Загрузка ЦП ВМ (использование ЦП ВМ, МГц / ограничение ЦП ВМ в МГц) превышает ''X'' % в 3 из 5 образцов.
|необходимый
|-
|VMCpuReadyMaxPercentage
|integer
|Готовность ЦП ВМ выше, чем ''X'' % в 3 из 5 выборок.
|необходимый
|}

==== Объект <code>EsxiHighMemoryDetectionConfig</code> ====
Конфигурация насыщения памяти при обнаружении хоста ESXi.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|EsxiHighMemoryThresholds
|Пользовательские пороги насыщения памяти на хосте ESXi. Если не установлено, то используется автоматический режим.
|необязательный
|}

==== Объект <code>EsxiHighMemoryThresholds</code> ====
Пользовательские пороги насыщения памяти на хосте ESXi. Если не установлено, то используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|compressionDecompressionRate
|number
|Предупреждать, если хост ESXi перекачивает IN/OUT или скорость сжатия/распаковки выше ''X'' килобайт в секунду в 3 из 5 выборок.
|необходимый
|}

==== Объект <code>OverloadedStorageDetectionConfig</code> ====
Конфигурация перегруженного хранилища при обнаружении физического устройства хранения.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|OverloadedStorageThresholds
|Пользовательские пороги для перегруженного хранилища на физическом устройстве хранения. Если не установлено, то используется автоматический режим.
|необязательный
|}

==== Объект <code>OverloadedStorageThresholds</code> ====
Пользовательские пороги для перегруженного хранилища на физическом устройстве хранения. Если не установлено, то используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|commandAbortsNumber
|integer
|Оповещение, если количество прерываний команды превышает ''X'' в 3 из 5 выборок.
|необходимый
|}

==== Объект <code>UndersizedStorageDetectionConfig</code> ====
Обнаружение устройства хранения меньшего размера
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|UndersizedStorageThresholds
|Пользовательские пороги для устройства хранения меньшего размера. Если не установлено, то используется автоматический режим.

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

==== Объект <code>UndersizedStorageThresholds</code> ====
Пользовательские пороги для устройства хранения меньшего размера. Если не установлено, то используется автоматический режим.

Выполнение любого условия вызывает оповещение.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|averageQueueCommandLatency
|integer
|Средняя задержка команды очереди превышает ''X'' миллисекунд в 3 из 5 образцов.
|необходимый
|-
|peakQueueCommandLatency
|integer
|Пиковая задержка команды очереди превышает ''X'' миллисекунд в 3 из 5 образцов.
|необходимый
|}

==== Объект <code>SlowPhysicalStorageDetectionConfig</code> ====
Конфигурация физического устройства хранения работает с медленным обнаружением.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|SlowPhysicalStorageThresholds
|Пользовательские пороги для медленно работающего физического устройства хранения. Если не установлено, то используется автоматический режим.

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

==== Объект <code>SlowPhysicalStorageThresholds</code> ====
Пользовательские пороги для медленно работающего физического устройства хранения. Если не установлено, то используется автоматический режим.

Выполнение любого условия вызывает оповещение.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|avgReadWriteLatency
|integer
|Задержка чтения/записи превышает ''X'' миллисекунд в 4 из 5 образцов.
|необходимый
|-
|peakReadWriteLatency
|integer
|Пиковое значение задержки чтения/записи превышает ''X'' миллисекунд в 4 из 5 выборок.
|необходимый
|}

==== Объект <code>DroppedPacketsDetectionConfig</code> ====
Конфигурация обнаружения большого количества потерянных пакетов.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|DroppedPacketsThresholds
|Пользовательские пороги для большого количества потерянных пакетов. Если не установлено, то используется автоматический режим.
|необязательный
|}

==== Объект <code>DroppedPacketsThresholds</code> ====
Пользовательские пороги для большого количества потерянных пакетов. Если не установлено, то используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|dropPacketsPerSecond
|integer
|Предупреждать, если скорость приема/передачи отброшенных пакетов на сетевом адаптере превышает ''X'' пакетов в секунду в 3 из 5 выборок.
|необходимый
|}

==== Объект <code>LowDatastoreSpaceDetectionConfig</code> ====
Конфигурация обнаружения нехватки свободного места в хранилище данных.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|необходимый
|-
|customThresholds
|LowDatastoreSpaceThresholds
|Пользовательские пороги для низкого свободного места в хранилище данных. Если не установлено, то используется автоматический режим.
|необязательный
|}

==== Объект <code>LowDatastoreSpaceThresholds</code> ====
Пользовательские пороги для низкого свободного места в хранилище данных. Если не установлено, то используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|freeSpacePercentage
|integer
|Предупреждать, если свободного места в хранилище данных меньше ''X'' %.
|необходимый
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"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
}
}
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|204
|
|Успех. Конфигурация обновлена. Ответ не имеет тела.
|-
|400
|ErrorEnvelope
|Неуспешно. Ввод недействителен.
|}

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

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

=== Аутентификация ===
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>WriteConfig</code>

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

=== Ответ ===

==== Коды ответов ====
{| class="wikitable"
!Код
|Тип
!Описание
|-
|204
|
|Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.
|-
|400
|ErrorEnvelope
|Неуспешно. Ввод недействителен.
|}

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

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

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

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

==== Curl ====
<code>curl -X PUT \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/vmware</nowiki> \
-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
}
}
'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/vmware</nowiki></code>

==== Тело запроса ====
<code>{
"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
}
}</code>

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

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

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