list-activated-rules-in-rule-group
Описание
Примечание
Это документация для AWS WAF Classic. Дополнительную информацию см. в руководстве разработчика по AWS WAF Classic.
Возвращает массив объектов ActivatedRule.
См. также: Документацию API AWS
list-activated-rules-in-rule-group — это оперирование с постраничным выводом. Для получения всех данных запроса могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ActivatedRules
Синтаксис
list-activated-rules-in-rule-group
[--rule-group-id <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]
Параметры
--rule-group-id (строка)
RuleGroupId группы правил (RuleGroup), для которой требуется получить список объектов ActivatedRule.--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для использования в фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/отключение цветного вывода.
- включить
- выключить
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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.
Вывод
NextMarker -> (строка)
ActivatedRules, чем указано в запросе для Limit, ответ включает значение NextMarker. Чтобы перечислить больше ActivatedRules, отправьте другой запрос ListActivatedRulesInRuleGroup и укажите значение NextMarker из ответа в поле NextMarker в следующем запросе.ActivatedRules -> (список)
Массив объектов ActivatedRules.
(структура)
Примечание
Это документация AWS WAF Classic. Дополнительную информацию см. в руководстве разработчика AWS WAF Classic.
Объект ActivatedRule в запросе UpdateWebACL указывает Rule, которое нужно вставить или удалить, приоритет Rule в WebACL и действие, которое AWS WAF должен выполнить при соответствии веб-запроса Rule (ALLOW, BLOCK или COUNT).
Чтобы указать, нужно ли вставлять или удалять Rule, используйте параметр Action в типе данных WebACLUpdate.
Priority -> (целое число)
Rules в WebACL оцениваются. Правила с меньшим значением для Priority оцениваются до Rules с большим значением. Значение должно быть уникальным целым числом. Если вы добавляете несколько Rules в WebACL, значения не обязательно должны быть последовательными.RuleId -> (строка)
Уникальный идентификатор для Rule. Вы используете RuleId, чтобы получить дополнительную информацию о Rule (см. GetRule), обновить Rule (см. UpdateRule), вставить Rule в WebACL или удалить его из WebACL (см. UpdateWebACL) или удалить Rule из AWS WAF (см. DeleteRule).
RuleId возвращается функциями CreateRule и ListRules.Action -> (структура)
Указывает действие, которое CloudFront или AWS WAF выполняют, когда веб-запрос соответствует условиям в Rule. Допустимые значения для Action включают:
-
ALLOW: CloudFront отвечает запрошенным объектом. -
BLOCK: CloudFront отвечает кодом состояния HTTP 403 (Запрещено). -
COUNT: AWS WAF увеличивает счётчик запросов, соответствующих условиям в правиле, а затем продолжает проверять веб-запрос на основе оставшихся правил в веб-ACL.
ActivatedRule|OverrideAction применяется только при обновлении или добавлении RuleGroup в WebACL. В этом случае вы не используете ActivatedRule|Action. Для всех остальных запросов обновления вместо ActivatedRule|OverrideAction используется ActivatedRule|Action.Type -> (строка)
Указывает, как AWS WAF должен реагировать на запросы, соответствующие настройкам в Rule. Допустимые значения включают:
-
ALLOW: AWS WAF разрешает запросы -
BLOCK: AWS WAF блокирует запросы -
COUNT: AWS WAF увеличивает счётчик запросов, соответствующих всем условиям в правиле. Затем AWS WAF продолжает проверять веб-запрос на основе оставшихся правил в веб-ACL. Вы не можете указатьCOUNTдля действия по умолчанию дляWebACL.
OverrideAction -> (структура)
Используйте OverrideAction для тестирования вашего RuleGroup.
Любое правило в RuleGroup может потенциально заблокировать запрос. Если вы установите OverrideAction в None, RuleGroup заблокирует запрос, если любое отдельное правило в RuleGroup соответствует запросу и настроено на блокировку этого запроса. Однако, если вы хотите сначала протестировать RuleGroup, установите OverrideAction в Count. RuleGroup тогда переопределит любое действие блокировки, заданное отдельными правилами, содержащимися в группе. Вместо блокировки соответствующих запросов эти запросы будут подсчитаны. Вы можете просмотреть запись подсчитанных запросов с помощью GetSampledRequests.
ActivatedRule|OverrideAction применяется только при обновлении или добавлении RuleGroup в WebACL. В этом случае вы не используете ActivatedRule|Action. Для всех остальных запросов обновления используется ActivatedRule|Action вместо ActivatedRule|OverrideAction.Type -> (строка)
COUNT переопределяет действие, указанное отдельным правилом в RuleGroup. Если установлено значение NONE, действие правила будет выполнено.Type -> (строка)
REGULAR, как определено в Rule, либо RATE_BASED, как определено в RateBasedRule, или GROUP, как определено в RuleGroup. По умолчанию - REGULAR. Хотя это поле необязательно, помните, что если вы попытаетесь добавить правило RATE_BASED в веб-ACL без установки типа, запрос UpdateWebACL завершится неудачей, поскольку запрос пытается добавить правило REGULAR с указанным идентификатором, которого не существует.ExcludedRules -> (список)
Массив правил, которые нужно исключить из группы правил. Это применимо только когда ActivatedRule относится к RuleGroup.
Иногда необходимо устранять неполадки в группах правил, которые блокируют трафик неожиданно (ложные срабатывания). Одним из методов устранения неполадок является выявление конкретного правила в группе правил, которое блокирует легитимный трафик, а затем отключение (исключение) этого конкретного правила. Вы можете исключать правила как из собственных групп правил, так и из групп правил AWS Marketplace, которые были связаны с веб-ACL.
Указание ExcludedRules не удаляет эти правила из группы правил. Вместо этого оно изменяет действие для правил на COUNT. Следовательно, запросы, соответствующие ExcludedRule, подсчитываются, но не блокируются. Владелец RuleGroup получит метрики COUNT для каждого ExcludedRule.
Если вы хотите исключить правила из группы правил, которая уже связана с веб-ACL, выполните следующие действия:
- Используйте журналы AWS WAF, чтобы определить идентификаторы правил, которые вы хотите исключить. Дополнительную информацию о журналах см. в разделе Ведение журнала информации о трафике веб-ACL.
- Отправьте запрос UpdateWebACL, в котором есть два действия:
- Первое действие удаляет существующую группу правил из веб-ACL. То есть, в запросе UpdateWebACL первое
Updates:Actionдолжно бытьDELETEиUpdates:ActivatedRule:RuleIdдолжно быть группой правил, содержащей правила, которые вы хотите исключить. - Второе действие вставляет ту же группу правил обратно, но указывая правила для исключения. То есть, второе
Updates:Actionдолжно бытьINSERT,Updates:ActivatedRule:RuleIdдолжно быть группой правил, которую вы только что удалили, иExcludedRulesдолжно содержать правила, которые вы хотите исключить.
- Первое действие удаляет существующую группу правил из веб-ACL. То есть, в запросе UpdateWebACL первое
(структура)
Примечание
Это документация AWS WAF Classic. Дополнительную информацию см. в руководстве разработчика AWS WAF Classic.
Правило для исключения из группы правил. Это применимо только когда ActivatedRule относится к RuleGroup. Правило должно принадлежать RuleGroup, которая указана в ActivatedRule.
RuleId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.