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

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

2025-01-02T17:49:46Z

← Предыдущая версия		Версия от 17:49, 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]] / GET конфигурация'''''

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

IKuznetsov в 15:58, 26 декабря 2024

2024-12-26T15:58:45Z

← Предыдущая версия		Версия от 15:58, 26 декабря 2024
Строка 95:		Строка 95:
	\|clusterVersion		\|clusterVersion
	\|string		\|string
	\|Версия ~~Ключ-АСТРОМ~~.		\|Версия АппОптима.
	\|}		\|}

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

	== Пример ==		== Пример ==
Строка 431:		Строка 431:
	<curl -X GET \		<curl -X GET \
	<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'~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

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

2024-12-26T09:35:19Z

← Предыдущая версия		Версия от 09:35, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Ключ-АСТРОМ 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>
	\|-		\|-
Строка 363:		Строка 363:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"metadata": {		"metadata": {
	"configurationVersions": [		"configurationVersions": [
Строка 429:		Строка 429:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	<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'</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
Строка 437:		Строка 437:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"metadata": {		"metadata": {
	"clusterVersion": "1.164.0.20190204-124711",		"clusterVersion": "1.164.0.20190204-124711",

ENetrebin: /* Пример */

2023-03-09T17:15:53Z

Пример

← Предыдущая версия		Версия от 17:15, 9 марта 2023
Строка 425:		Строка 425:

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

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

	==== Curl ====		==== Curl ====

ENetrebin: /* Объект _ ConfigurationMetadata */

2023-03-09T17:10:20Z

Объект _ ConfigurationMetadata

← Предыдущая версия		Версия от 17:10, 9 марта 2023
Строка 78:		Строка 78:
	\|}		\|}

	==== Объект _ <code>ConfigurationMetadata</code> ====		==== Объект <code>ConfigurationMetadata</code> ====
	Метаданные, полезные для отладки		Метаданные, полезные для отладки
	{\| class="wikitable"		{\| class="wikitable"

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

2023-03-09T17:09:43Z

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

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

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

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Ключ-АСТРОМ 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>ReadConfig</code>

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

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

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Конфигурация обнаружения аномалий V Mware
|Успех
|}

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

==== Объект <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
|
|-
|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>

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

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

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

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

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

==== Тело ответа ====
<code>{
"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
}
}</code>

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