[ aws . cloudwatch ]
describe-anomaly-detectors
Описание
Отображает модели обнаружения аномалий, которые вы создали в своей учетной записи. Для детекторов аномалий по одной метрике вы можете отобразить все модели в вашей учетной записи или отфильтровать результаты, чтобы отобразить только модели, связанные с определенным пространством имен, именем метрики или измерениями метрики. Для детекторов аномалий по математическим операциям над метриками вы можете отобразить их, добавив METRIC_MATH в массив AnomalyDetectorTypes. Это вернёт все детекторы аномалий по математическим операциям над метриками в вашей учетной записи.
См. также: Документация API AWS
describe-anomaly-detectors — это постраничный запрос. Для получения всего набора результатов могут потребоваться несколько запросов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной разметкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: AnomalyDetectors
Синтаксис
describe-anomaly-detectors
[--namespace <value>]
[--metric-name <value>]
[--dimensions <value>]
[--anomaly-detector-types <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--namespace (строка)
--metric-name (строка)
--dimensions (список)
Ограничивает результаты только моделями обнаружения аномалий, связанными с указанными измерениями метрики. Если существует несколько метрик с этими измерениями, и с ними связаны модели обнаружения аномалий, они все возвращаются.
(структура)
Измерение — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаете новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения для этого измерения.
Вы можете назначить до 30 измерений одной метрике.
Имя -> (строка)
:). ASCII-управляющие символы не поддерживаются в качестве части имён измерений.Значение -> (строка)
Сокращённый синтаксис:
Name=string,Value=string ...
Синтаксис JSON:
[
{
"Name": "string",
"Value": "string"
}
...
]
--anomaly-detector-types (список)
Типы детекторов аномалий, которые необходимо запросить при использовании DescribeAnomalyDetectorsInput. Если пусто, по умолчанию равно SINGLE_METRIC.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
SINGLE_METRIC
METRIC_MATH
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен, определяющий, с какой точки начать постраничную разметку. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная разметка в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная разметка в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, возвращаемых в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная разметка в Руководстве пользователя AWS Command Line Interface.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включить отладочную запись.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (логическое значение)
Отключить автоматическую постраничную разметку. Если автоматическая постраничная разметка отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла с вашими учетными данными.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Показать версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- включено
- выключено
- автоматически
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Пакет сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставленного с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить постраничную разметку CLI для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования, аналогичные правилам Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для получения списка моделей обнаружения аномалий
Следующий пример describe-anomaly-detectors отображает информацию о моделях обнаружения аномалий, связанных с пространством имен AWS/Logs в указанной учетной записи.
aws cloudwatch describe-anomaly-detectors \
--namespace AWS/Logs
Вывод:
{
"AnomalyDetectors": [
{
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [],
"Stat": "SampleCount",
"Configuration": {
"ExcludedTimeRanges": []
},
"StateValue": "TRAINED",
"SingleMetricAnomalyDetector": {
"AccountId": "123456789012",
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [],
"Stat": "SampleCount"
}
},
{
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [
{
"Name": "LogGroupName",
"Value": "demo"
}
],
"Stat": "Average",
"Configuration": {
"ExcludedTimeRanges": []
},
"StateValue": "PENDING_TRAINING",
"SingleMetricAnomalyDetector": {
"AccountId": "123456789012",
"Namespace": "AWS/Logs",
"MetricName": "IncomingBytes",
"Dimensions": [
{
"Name": "LogGroupName",
"Value": "demo"
}
],
"Stat": "Average"
}
}
]
}
Дополнительную информацию см. в разделе Использование обнаружения аномалий CloudWatch в Руководстве пользователя Amazon CloudWatch.
Вывод
AnomalyDetectors -> (список)
Список моделей обнаружения аномалий, возвращённых операцией.
(структура)
Модель обнаружения аномалий, связанная с определённым метрикой CloudWatch, статистикой или выражением метрической математики. Вы можете использовать модель для отображения диапазона ожидаемых, нормальных значений при отображении метрики.
Если вы включили унифицированную межсчётную наблюдаемость, и этот счёт является счётчиком мониторинга, метрика может находиться в том же счёте или в исходном счёте.
Namespace -> (строка)
MetricName -> (строка)
Dimensions -> (список)
Метрики размеров, связанные с моделью обнаружения аномалий.
(структура)
Размер — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку размеры являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» в одну из своих метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размера и фактический идентификатор экземпляра в качестве значения для этого размера.
Вы можете назначить до 30 размеров метрике.
Name -> (строка)
:). ASCII-управляющие символы не поддерживаются в качестве части имён размеров.Value -> (строка)
Stat -> (строка)
Configuration -> (структура)
Настройка определяет подробности о том, как модель обнаружения аномалий должна быть обучена, включая временные диапазоны, которые следует исключить из использования для обучения модели, и часовой пояс, который следует использовать для метрики.
ExcludedTimeRanges -> (список)
Массив временных диапазонов, которые следует исключить из использования при обучении модели обнаружения аномалий. Используйте это, чтобы убедиться, что события, которые могут вызвать необычные значения для метрики, такие как развертывания, не используются при создании модели CloudWatch.
(структура)
Указывает диапазон дней или времени, которые следует исключить из использования для обучения модели обнаружения аномалий.
StartTime -> (метка времени)
yyyy-MM-dd'T'HH:mm:ss . Например, 2019-07-01T23:59:59 .EndTime -> (метка времени)
yyyy-MM-dd'T'HH:mm:ss . Например, 2019-07-01T23:59:59 .MetricTimezone -> (строка)
Часовой пояс для метрики. Это полезно, чтобы модель автоматически учитывала изменения времени по летнему времени, если метрика чувствительна к таким изменениям.
Для указания часового пояса используйте имя часового пояса, указанное в стандартной базе данных tz. Дополнительная информация см. в базе данных tz .
StateValue -> (строка)
MetricCharacteristics -> (структура)
Этот объект включает параметры, которые вы можете использовать для предоставления информации о вашей метрике в CloudWatch, чтобы помочь ему создать более точные модели обнаружения аномалий. В настоящее время он включает параметр PeriodicSpikes.
PeriodicSpikes -> (логическое значение)
true, если значения для этой метрики постоянно включают всплески, которые не должны считаться аномалиями. При установке в значение true CloudWatch будет ожидать увидеть всплески, которые появлялись постоянно в период обучения модели, и не будет помечать будущие аналогичные всплески как аномалии.SingleMetricAnomalyDetector -> (структура)
Метрика CloudWatch и статистика для этого детектора аномалий.
AccountId -> (строка)
Namespace -> (строка)
MetricName -> (строка)
Dimensions -> (список)
Размеры метрики для создания модели обнаружения аномалий.
(структура)
Размер — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку размеры являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» в одну из своих метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размера и фактический идентификатор экземпляра в качестве значения для этого размера.
Вы можете назначить до 30 размеров метрике.
Name -> (строка)
:). ASCII-управляющие символы не поддерживаются в качестве части имён размеров.Value -> (строка)
Stat -> (строка)
MetricMathAnomalyDetector -> (структура)
Выражение для вычисления метрик CloudWatch для данного детектора аномалий.
MetricDataQueries -> (список)
Массив структур запросов данных метрик, позволяющий создать детектор аномалий на основе результата выражения для вычисления метрик. Каждый элемент в MetricDataQueries получает метрику или выполняет математическое выражение. Один элемент в MetricDataQueries является выражением, которое предоставляет временной ряд, используемый детектором аномалий в качестве входных данных. Укажите выражение, установив ReturnData в значение true для этого объекта в массиве. Для всех остальных выражений и метрик установите ReturnData в значение false. Указанное выражение должно возвращать один временной ряд.
(структура)
Эта структура используется как в GetMetricData, так и в PutMetricAlarm. Поддерживаемое использование этой структуры отличается для этих двух операций.
При использовании в GetMetricData она указывает данные метрики для возврата и то, является ли этот вызов просто получением набора данных для одной метрики или выполняет запрос Metrics Insights или математическое выражение. Один вызов GetMetricData может включать до 500 структур MetricDataQuery.
При использовании в PutMetricAlarm она позволяет создавать сигнал тревоги на основе выражения для вычисления метрик. Каждый MetricDataQuery в массиве определяет либо метрику для извлечения, либо математическое выражение, которое должно быть выполнено над извлечёнными метриками. Один вызов PutMetricAlarm может включать до 20 структур MetricDataQuery в массиве. 20 структур могут включать до 10 структур, содержащих параметр MetricStat для получения метрики, и до 10 структур, содержащих параметр Expression для выполнения математического выражения. Из этих структур Expression одна должна иметь true в качестве значения для ReturnData. Результат этого выражения — значение, за которым следит сигнал тревоги.
Любое выражение, используемое в операции PutMetricAlarm, должно возвращать один временной ряд. Дополнительную информацию см. в разделе Синтаксис и функции вычисления метрик в Руководстве пользователя Amazon CloudWatch.
Некоторые параметры этой структуры также имеют разное использование, если вы используете эту структуру в операции GetMetricData или в операции PutMetricAlarm. Эти различия объяснены в следующем списке параметров.
Id -> (строка)
GetMetricData. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении. Допустимые символы — буквы, цифры и знак подчёркивания. Первый символ должен быть строчной буквой.MetricStat -> (структура)
Метрика, которая должна быть возвращена, вместе со статистикой, периодом и единицами измерения. Используйте этот параметр только в том случае, если этот объект извлекает метрику, а не выполняет математическое выражение над возвращаемыми данными.
Внутри одного объекта MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.
Metric -> (структура)
Метрика для возврата, включая имя метрики, пространство имён и измерения.
Namespace -> (строка)
MetricName -> (строка)
Dimensions -> (список)
Измерения для метрики.
(структура)
Измерение — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, всякий раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаёте новую разновидность этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения и фактический идентификатор экземпляра в качестве значения этого измерения.
Вы можете назначить до 30 измерений метрике.
Name -> (строка)
:). ASCII-управляющие символы не поддерживаются в именах измерений.Value -> (строка)
Period -> (целое число)
Грань, в секундах, возвращаемых точек данных. Для метрик с регулярным разрешением период может быть не короче одной минуты (60 секунд) и должен быть кратен 60. Для высокоразрешающих метрик, которые собираются с интервалами менее одной минуты, период может составлять 1, 5, 10, 20, 30, 60 или кратное 60. Высокоразрешающие метрики — это те метрики, которые хранятся операцией PutMetricData, которая включает StorageResolution в 1 секунду.
Если параметр StartTime задаёт отметку времени, которая более чем на 3 часа назад, вы должны указать период следующим образом, иначе точки данных в этом временном интервале не будут возвращены:
- Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минуте).
- Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минутам).
- Время начала более чем 63 днями назад — используйте кратное 3600 секундам (1 часу).
Stat -> (строка)
Unit -> (строка)
При использовании операции Put это определяет единицу измерения, которую вы хотите использовать при хранении метрики.
В операции Get, если вы опустите Unit, будут возвращены все данные, собранные с любой единицей измерения, вместе с соответствующими единицами, которые были указаны при отправке данных в CloudWatch. Если вы укажете единицу измерения, операция вернёт только данные, собранные с этой единицей. Если вы укажете единицу измерения, которая не соответствует собранным данным, результат операции будет пустым. CloudWatch не выполняет преобразование единиц измерения.
Expression -> (строка)
Это поле может содержать либо запрос Metrics Insights, либо выражение для вычисления метрик, которое должно быть выполнено над возвращаемыми данными. Дополнительную информацию о запросах Metrics Insights см. в разделе Компоненты и синтаксис запросов Metrics Insights в Руководстве пользователя Amazon CloudWatch.
Математическое выражение может использовать Id других метрик или запросов, чтобы сослаться на эти метрики, а также может использовать Id других выражений, чтобы использовать результат этих выражений. Дополнительную информацию о математических выражениях для метрик см. в разделе Синтаксис и функции вычисления метрик в Руководстве пользователя Amazon CloudWatch.
В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.
Label -> (строка)
Человекопонятное обозначение для этой метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что представляет значение. Если метрика или выражение отображаются в виджете панели мониторинга CloudWatch, отображается метка. Если метка опущена, CloudWatch генерирует значение по умолчанию.
Вы можете поместить динамические выражения в метку, чтобы она была более информативной. Дополнительную информацию см. в разделе Использование динамических меток.
ReturnData -> (булево)
При использовании в GetMetricData этот параметр указывает, следует ли возвращать отметки времени и исходные значения данных этой метрики. Если вы выполняете этот вызов только для выполнения математических выражений и не нуждаетесь в возврате исходных данных, вы можете указать false. Если вы этого не сделаете, используется значение по умолчанию true.
При использовании в PutMetricAlarm укажите true для использования результата одного выражения в качестве сигнала тревоги. Для всех остальных метрик и выражений в той же операции PutMetricAlarm установите значение ReturnData в False.
Period -> (целое число)
PutMetricData, которая включает StorageResolution of 1 second.AccountId -> (строка)
Идентификатор учётной записи, в которой находятся метрики.
Если вы выполняете операцию GetMetricData в учётной записи мониторинга, используйте этот параметр для указания учётной записи, из которой нужно получить метрику.
Если вы выполняете операцию PutMetricAlarm, используйте этот параметр для указания учётной записи, в которой находится метрика, за которой следит сигнал тревоги.
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.