Spec-Zone.ru › AWS CLI v2

[ aws . waf-regional ]

get-rate-based-rule

Описание

Примечание

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

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

Возвращает RateBasedRule, который определяется RuleId, включённой в запрос GetRateBasedRule.

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

Синтаксис

  get-rate-based-rule
--rule-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]

Параметры

--rule-id (строка)

Идентификатор RateBasedRule, который вы хотите получить. RuleId возвращается командами CreateRateBasedRule и ListRateBasedRules.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичным данным, 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.

Вывод

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

Информация о RateBasedRule, указанная в запросе GetRateBasedRule.

RuleId -> (строка)

Уникальный идентификатор RateBasedRule. Используйте RuleId для получения дополнительной информации о RateBasedRule (см. GetRateBasedRule ), обновление RateBasedRule (см. UpdateRateBasedRule ), вставку RateBasedRule в WebACL или удаление из WebACL (см. UpdateWebACL ), или удаление RateBasedRule из AWS WAF (см. DeleteRateBasedRule).

Name -> (строка)

Наименование или описание RateBasedRule. Вы не можете изменить имя RateBasedRule после его создания.

MetricName -> (строка)

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

MatchPredicates -> (список)

Объект Predicates содержит один элемент Predicate для каждого объекта ByteMatchSet, IPSet или SqlInjectionMatchSet, который вы хотите включить в RateBasedRule.

(структура)

Примечание

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

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

Указывает объекты ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet и SizeConstraintSet, которые вы хотите добавить в Rule, и для каждого объекта указывает, хотите ли вы инвертировать настройки, например, запросы, которые НЕ происходят с IP-адреса 192.0.2.44.

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

Установите Negated в False, если вы хотите, чтобы AWS WAF разрешал, блокировал или подсчитывал запросы на основе настроек в указанном ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet или SizeConstraintSet. Например, если IPSet включает IP-адрес 192.0.2.44, AWS WAF будет разрешать или блокировать запросы на основе этого IP-адреса.

Установите Negated в True, если вы хотите, чтобы AWS WAF разрешал или блокировал запрос на основе отрицания настроек в ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet или SizeConstraintSet. Например, если IPSet включает IP-адрес 192.0.2.44, AWS WAF будет разрешать, блокировать или подсчитывать запросы на основе всех IP-адресов, *кроме* 192.0.2.44.

Type -> (строка)

Тип предиката в Rule, например, ByteMatch или IPSet.

DataId -> (строка)

Уникальный идентификатор предиката в Rule, например, ByteMatchSetId или IPSetId. Идентификатор возвращается соответствующей командой Create или List.

RateKey -> (строка)

Поле, которое AWS WAF использует для определения того, поступают ли запросы, скорее всего, от одного источника, и, следовательно, подлежат мониторингу скорости. Единственное допустимое значение для RateKey — IP. IP указывает, что запросы, поступающие с одного IP-адреса, подлежат RateLimit, указанной в RateBasedRule.

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

Максимальное количество запросов, имеющих идентичное значение в поле, указанное RateKey, разрешенное в течение пятиминутного периода. Если количество запросов превышает RateLimit и другие предикаты, указанные в правиле, также выполняются, AWS WAF запускает действие, указанное для этого правила.

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

Spec-Zone.ru

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