Spec-Zone.ru › AWS CLI v2

[ aws . waf-regional ]

list-activated-rules-in-rule-group

Описание

Примечание

Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.

Для последней версии AWS WAF используйте API AWS WAFV2 и см. Руководство разработчика AWS WAF. В последней версии AWS WAF имеет единый набор конечных точек для региональных и глобальных применений.

Возвращает массив объектов ActivatedRule.

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

Синтаксис

  list-activated-rules-in-rule-group
[--rule-group-id <value>]
[--next-marker <value>]
[--limit <value>]
[--cli-input-json | --cli-input-yaml]
[--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 (строка)

Идентификатор группы правил RuleGroup, для которой требуется получить список объектов ActivatedRule.

--next-marker (строка)

Если вы укажете значение для Limit, и у вас есть больше ActivatedRules, чем значение Limit, AWS WAF возвращает значение NextMarker в ответе, которое позволяет вам перечислить другую группу ActivatedRules. Для второго и последующих запросов ListActivatedRulesInRuleGroup укажите значение NextMarker из предыдущего ответа, чтобы получить информацию о другой группе ActivatedRules.

--limit (целое число)

Указывает количество ActivatedRules, которое вы хотите, чтобы AWS WAF вернул для этого запроса. Если у вас больше ActivatedRules, чем число, которое вы указали для Limit, ответ включает значение NextMarker, которое вы можете использовать для получения другой группы ActivatedRules.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, заданные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, заданного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--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 (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--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.

Вывод

NextMarker -> (строка)

Если у вас больше ActivatedRules, чем количество, указанное для Limit в запросе, ответ включает значение NextMarker. Чтобы получить список дополнительных ActivatedRules, отправьте ещё один запрос ListActivatedRulesInRuleGroup и укажите значение NextMarker из ответа в качестве значения NextMarker в следующем запросе.

ActivatedRules -> (список)

Массив объектов ActivatedRules.

(структура)

Примечание

Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.

Для последней версии AWS WAF используйте API AWS WAFV2 и см. руководство разработчика AWS WAF. В последней версии AWS WAF использует единый набор конечных точек для регионального и глобального использования.

Объект ActivatedRule в запросе UpdateWebACL определяет Rule, которое вы хотите вставить или удалить, приоритет Rule в WebACL и действие, которое AWS WAF должен выполнить, когда веб-запрос соответствует Rule (ALLOW, BLOCK или COUNT).

Чтобы указать, нужно ли вставить или удалить Rule, используйте параметр Action в типе данных WebACLUpdate.

Priority -> (целое число)

Указывает порядок, в котором правила Rules в WebACL оцениваются. Правила с меньшим значением Priority оцениваются раньше правил с большим значением. Значение должно быть уникальным целым числом. Если вы добавляете несколько Rules в WebACL, значения не обязательно должны быть последовательными.

RuleId -> (строка)

Уникальный идентификатор 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|Action вместо ActivatedRule|OverrideAction.

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 получит метрики подсчёта для каждой ExcludedRule.

Если вы хотите исключить правила из группы правил, которая уже связана с веб-ACL, выполните следующие действия:

  • Используйте журналы AWS WAF, чтобы определить идентификаторы правил, которые вы хотите исключить. Для получения дополнительной информации о журналах см. Logging Web ACL Traffic Information.
  • Отправьте запрос UpdateWebACL, содержащий два действия:
    • Первое действие удаляет существующую группу правил из веб-ACL. То есть в запросе UpdateWebACL первое Updates:Action должно быть DELETE, а Updates:ActivatedRule:RuleId — группой правил, содержащей правила, которые вы хотите исключить.
    • Второе действие вставляет ту же группу правил обратно, но указывая правила для исключения. То есть, второе Updates:Action должно быть INSERT, Updates:ActivatedRule:RuleId должна быть группой правил, которую вы только что удалили, а ExcludedRules должна содержать правила, которые вы хотите исключить.

(структура)

Примечание

Это документация по AWS WAF Classic. Для получения дополнительной информации см. AWS WAF Classic в руководстве разработчика.

Для последней версии AWS WAF используйте API AWS WAFV2 и см. руководство разработчика AWS WAF. В последней версии AWS WAF использует единый набор конечных точек для регионального и глобального использования.

Правило для исключения из группы правил. Это применимо только тогда, когда ActivatedRule относится к RuleGroup. Правило должно принадлежать RuleGroup, указанной в ActivatedRule.

RuleId -> (строка)

Уникальный идентификатор правила, подлежащего исключению из группы правил.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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