Spec-Zone.ru › AWS CLI v2

[ aws . waf ]

get-web-acl

Описание

Примечание

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

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

Возвращает WebACL, указанный по WebACLId.

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

Синтаксис

  get-web-acl
--web-acl-id <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]

Параметры

--web-acl-id (строка)

Идентификатор WebACL, который вы хотите получить. WebACLId возвращается командами CreateWebACL и ListWebACLs.

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

Вывод

WebACL -> (структура)

Информация о WebACL, которую вы указали в запросе GetWebACL. Для получения дополнительной информации, см. следующие разделы:

  • WebACL : Содержит DefaultAction , MetricName , Name , массив объектов Rule и WebACLId
  • DefaultAction (Тип данных WafAction ): Содержит Type
  • Rules : Содержит массив объектов ActivatedRule, которые содержат Action , Priority и RuleId
  • Action : Содержит Type

WebACLId -> (строка)

Уникальный идентификатор WebACL. Вы используете WebACLId для получения информации о WebACL (см. GetWebACL), обновления WebACL (см. UpdateWebACL) и удаления WebACL из AWS WAF (см. DeleteWebACL).

WebACLId возвращается методами CreateWebACL и ListWebACLs.

Name -> (строка)

Дружественное имя или описание WebACL. Вы не можете изменить имя WebACL после его создания.

MetricName -> (строка)

Дружественное имя или описание метрик для этой WebACL. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9), с максимальной длиной 128 и минимальной длиной 1. Оно не может содержать пробелы или зарезервированные имена метрик AWS WAF, включая «All» и «Default_Action». Вы не можете изменить MetricName после создания WebACL.

DefaultAction -> (структура)

Действие, которое выполняется, если ни одно из Rules, содержащихся в WebACL, не совпадает. Действие задается объектом WafAction.

Type -> (строка)

Определяет, как AWS WAF должен отвечать на запросы, соответствующие настройкам в Rule. Допустимые значения включают:

  • ALLOW : AWS WAF разрешает запросы
  • BLOCK : AWS WAF блокирует запросы
  • COUNT : AWS WAF увеличивает счётчик запросов, соответствующих всем условиям правила. AWS WAF продолжает проверку веб-запроса на основе оставшихся правил в веб-ACL. Вы не можете указать COUNT для действия по умолчанию для WebACL.

Rules -> (список)

Массив, содержащий действие для каждого Rule в WebACL, приоритет Rule и идентификатор Rule.

(структура)

Примечание

Это документация по 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 с большим значением. Значение должно быть уникальным целым числом. Если вы добавляете несколько 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, чтобы определить идентификаторы правил, которые вы хотите исключить. Дополнительную информацию о журналах см. в разделе Ведение журнала информации о трафике веб-ACL.
  • Отправьте запрос 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 -> (строка)

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

WebACLArn -> (строка)

Идентификатор ресурса Amazon (ARN) веб-ACL.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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