Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

получить-метки-фильтров

Описание

Отображает указанные метки фильтров. Можно отобразить все метки фильтров или отфильтровать результаты по имени журнала, префиксу, имени метрики или пространству имен метрики. Результаты отсортированы в лексикографическом порядке по имени фильтра.

См. также: Документация API AWS

describe-metric-filters является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничном запросе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: metricFilters

Синтаксис

  describe-metric-filters
[--log-group-name <value>]
[--filter-name-prefix <value>]
[--metric-name <value>]
[--metric-namespace <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]

Параметры

--log-group-name (строка)

Имя группы журналов.

--filter-name-prefix (строка)

Префикс для сопоставления. CloudWatch Logs использует это значение только в случае, если вы также включили параметр logGroupName в свой запрос.

--metric-name (строка)

Фильтрует результаты, включая только те, у которых указано имя метрики. Если вы включаете этот параметр в свой запрос, вы также должны включить параметр metricNamespace.

--metric-namespace (строка)

Фильтрует результаты, включая только те, которые находятся в указанном пространстве имен. Если вы включаете этот параметр в свой запрос, вы также должны включить параметр metricName.

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

metricFilters -> (список)

Метки фильтров.

(структура)

Метки фильтров выражают, как CloudWatch Logs будет извлекать наблюдения метрик из входящих событий журнала и преобразовывать их в данные метрик в метрике CloudWatch.

filterName -> (строка)

Имя метки фильтра.

filterPattern -> (строка)

Символическое описание того, как CloudWatch Logs должно интерпретировать данные в каждом событии журнала. Например, событие журнала может содержать временные метки, IP-адреса, строки и т. д. Вы используете шаблон фильтра, чтобы указать, что искать в сообщении события журнала.

metricTransformations -> (список)

Преобразования метрик.

(структура)

Указывает, как преобразовать входящие события журнала в данные метрик в метрике CloudWatch.

metricName -> (строка)

Имя метрики CloudWatch.

metricNamespace -> (строка)

Настраиваемое пространство имен для размещения метрики в CloudWatch. Используйте пространства имен для группировки похожих метрик. Дополнительная информация см. в разделе Пространства имен.

metricValue -> (строка)

Значение, которое нужно опубликовать в метрику CloudWatch, когда шаблон фильтра соответствует событию журнала.

defaultValue -> (двойное значение)

(необязательно) Значение, которое нужно выводить, когда шаблон фильтра не соответствует событию журнала. Это значение может быть null.

dimensions -> (карта)

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

Предупреждение

Метрики, извлеченные из событий журналов, оплачиваются как пользовательские метрики. Чтобы избежать неожиданных высоких платежей, не указывайте поля с высокой кардинальностью, такие как IPAddress или requestID, как измерения. Каждое разное значение, найденное для измерения, рассматривается как отдельная метрика и оплачивается как отдельная пользовательская метрика.

CloudWatch Logs отключает метки фильтра, если он генерирует 1000 различных пар имя/значение для ваших указанных измерений в определенное время. Это помогает предотвратить случайные высокие платежи.

Вы также можете настроить оповещение о счете, чтобы получать уведомления о том, что ваши расходы выше ожидаемого. Дополнительную информацию см. в разделе Создание оповещения о счете для отслеживания ваших ожидаемых расходов на Amazon Web Services.

key -> (строка)

value -> (строка)

unit -> (строка)

Единица измерения для присваивания метрике. Если вы ее опустите, единица измерения устанавливается как None .

creationTime -> (длинное целое число)

Время создания метки фильтра, выраженное количеством миллисекунд после Jan 1, 1970 00:00:00 UTC.

logGroupName -> (строка)

Имя группы журналов.

applyOnTransformedLogs -> (логическое значение)

Этот параметр действителен только для групп журналов, в которых активен преобразователь журналов. Дополнительную информацию о преобразователях журналов см. в разделе PutTransformer.

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

nextToken -> (строка)

Токен для следующего набора элементов для возврата. Токен истекает через 24 часа.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API