get-sampled-requests

Описание

Получает подробную информацию о заданном количестве запросов — выборке — которые WAF случайным образом выбирает из первых 5000 запросов, полученных вашим ресурсом Amazon Web Services в указанный вами временной интервал. Вы можете указать размер выборки до 500 запросов и любой временной интервал за последние три часа.

GetSampledRequests возвращает временной интервал, который, как правило, совпадает с указанным вами интервалом. Однако, если ваш ресурс (например, распределение CloudFront) получил 5000 запросов до истечения указанного временного интервала, GetSampledRequests возвращает обновленный временной интервал. Этот новый временной интервал указывает фактический период, в течение которого WAF выбрал запросы в выборке.

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

Синтаксис

  get-sampled-requests
--web-acl-arn <value>
--rule-metric-name <value>
--scope <value>
--time-window <value>
--max-items <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-arn (строка)

Amazon Resource Name (ARN) WebACL, для которого требуется выборка запросов.

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

Имя метрики, назначенной Rule или измерению RuleGroup, для которой требуется выборка запросов.

--scope (строка)

Указывает, относится ли это к глобальному типу ресурса, например, распределению Amazon CloudFront. Для приложения Amplify используйте CLOUDFRONT.

Для работы с CloudFront необходимо также указать регион США Восточный (Северная Вирджиния) следующим образом:

CLI — Укажите регион при использовании области CloudFront: --scope=CLOUDFRONT --region=us-east-1.
API и SDK — Для всех вызовов используйте конечную точку региона us-east-1.

Возможные значения:

CLOUDFRONT
REGIONAL

--time-window (структура)

Дата и время начала и окончания интервала, для которого требуется, чтобы GetSampledRequests вернул выборку запросов. Время необходимо указать в формате UTC. Формат UTC включает специальный обозначитель, Z . Например, "2016-09-27T14:50Z". Вы можете указать любой временной интервал за последние три часа. Если вы укажете время начала, которое раньше трех часов назад, WAF установит его на три часа назад.

StartTime -> (метка времени)

Начало временного интервала, из которого нужно, чтобы GetSampledRequests вернул выборку запросов, полученных вашим ресурсом Amazon Web Services. Время необходимо указать в формате UTC. Формат UTC включает специальный обозначитель, Z . Например, "2016-09-27T14:50Z". Вы можете указать любой временной интервал за последние три часа.

EndTime -> (метка времени)

Конец временного интервала, из которого нужно, чтобы GetSampledRequests вернул выборку запросов, полученных вашим ресурсом Amazon Web Services. Время необходимо указать в формате UTC. Формат UTC включает специальный обозначитель, Z . Например, "2016-09-27T14:50Z". Вы можете указать любой временной интервал за последние три часа.

Упрощенный синтаксис:

StartTime=timestamp,EndTime=timestamp

Синтаксис JSON:

{
  "StartTime": timestamp,
  "EndTime": timestamp
}

--max-items (длина)

Количество запросов, которое вы хотите, чтобы WAF вернул из первых 5000 запросов, полученных вашим ресурсом Amazon Web Services в течение указанного временного интервала. Если ваш ресурс получил меньше запросов, чем значение MaxItems, GetSampledRequests вернёт информацию обо всех них.

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

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено значение null или строка 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
таблица
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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения выборки веб-запросов для веб-ACL

Следующий get-sampled-requests получает выборку веб-запросов для указанного веб-ACL, метрики правил и временного интервала.

aws wafv2 get-sampled-requests \
    --web-acl-arn arn:aws:wafv2:us-west-2:123456789012:regional/webacl/test-cli/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --rule-metric-name AWS-AWSManagedRulesSQLiRuleSet \
    --scope=REGIONAL \
    --time-window StartTime=2020-02-12T20:00Z,EndTime=2020-02-12T21:10Z \
    --max-items 100

Вывод:

{
    "TimeWindow": {
    "EndTime": 1581541800.0,
    "StartTime": 1581537600.0
    },
    "SampledRequests": [
        {
            "Action": "BLOCK",
            "Timestamp": 1581541799.564,
            "RuleNameWithinRuleGroup": "AWS#AWSManagedRulesSQLiRuleSet#SQLi_BODY",
            "Request": {
                "Country": "US",
                "URI": "/",
                "Headers": [
                    {
                        "Name": "Host",
                        "Value": "alb-test-1EXAMPLE1.us-east-1.elb.amazonaws.com"
                    },
                    {
                        "Name": "Content-Length",
                        "Value": "7456"
                    },
                    {
                        "Name": "User-Agent",
                        "Value": "curl/7.53.1"
                    },
                    {
                        "Name": "Accept",
                        "Value": "/"
                    },
                    {
                        "Name": "Content-Type",
                        "Value": "application/x-www-form-urlencoded"
                    }
                ],
                "ClientIP": "198.51.100.08",
                "Method": "POST",
                "HTTPVersion": "HTTP/1.1"
            },
            "Weight": 1
        },
        {
            "Action": "BLOCK",
            "Timestamp": 1581541799.988,
            "RuleNameWithinRuleGroup": "AWS#AWSManagedRulesSQLiRuleSet#SQLi_BODY",
            "Request": {
                "Country": "US",
                "URI": "/",
                "Headers": [
                    {
                        "Name": "Host",
                        "Value": "alb-test-1EXAMPLE1.us-east-1.elb.amazonaws.com"
                    },
                    {
                        "Name": "Content-Length",
                        "Value": "7456"
                    },
                    {
                        "Name": "User-Agent",
                        "Value": "curl/7.53.1"
                    },
                    {
                        "Name": "Accept",
                        "Value": "/"
                    },
                    {
                        "Name": "Content-Type",
                        "Value": "application/x-www-form-urlencoded"
                    }
                ],
                "ClientIP": "198.51.100.08",
                "Method": "POST",
                "HTTPVersion": "HTTP/1.1"
            },
            "Weight": 3
        },
        {
            "Action": "BLOCK",
            "Timestamp": 1581541799.846,
            "RuleNameWithinRuleGroup": "AWS#AWSManagedRulesSQLiRuleSet#SQLi_BODY",
            "Request": {
                "Country": "US",
                "URI": "/",
                "Headers": [
                    {
                        "Name": "Host",
                        "Value": "alb-test-1EXAMPLE1.us-east-1.elb.amazonaws.com"
                    },
                    {
                        "Name": "Content-Length",
                        "Value": "7456"
                    },
                    {
                        "Name": "User-Agent",
                        "Value": "curl/7.53.1"
                    },
                    {
                        "Name": "Accept",
                        "Value": "/"
                    },
                    {
                        "Name": "Content-Type",
                        "Value": "application/x-www-form-urlencoded"
                    }
                ],
                "ClientIP": "198.51.100.08",
                "Method": "POST",
                "HTTPVersion": "HTTP/1.1"
            },
            "Weight": 1
        },
        {
            "Action": "BLOCK",
            "Timestamp": 1581541799.4,
            "RuleNameWithinRuleGroup": "AWS#AWSManagedRulesSQLiRuleSet#SQLi_BODY",
            "Request": {
                "Country": "US",
                "URI": "/",
                "Headers": [
                    {
                        "Name": "Host",
                        "Value": "alb-test-1EXAMPLE1.us-east-1.elb.amazonaws.com"
                    },
                    {
                        "Name": "Content-Length",
                        "Value": "7456"
                    },
                    {
                        "Name": "User-Agent",
                        "Value": "curl/7.53.1"
                    },
                    {
                        "Name": "Accept",
                        "Value": "/"
                    },
                    {
                        "Name": "Content-Type",
                        "Value": "application/x-www-form-urlencoded"
                    }
                ],
                "ClientIP": "198.51.100.08",
                "Method": "POST",
                "HTTPVersion": "HTTP/1.1"
            },
            "Weight": 1
        }
    ],
    "PopulationSize": 4
}

Дополнительную информацию см. в разделе Просмотр выборки веб-запросов в Руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

SampledRequests -> (список)

Сложный тип, содержащий подробную информацию о каждом из запросов в выборке.

(структура)

Представляет отдельный проанализированный веб-запрос. Ответ от GetSampledRequests включает сложный тип SampledHTTPRequests, который отображается как SampledRequests в синтаксисе ответа. SampledHTTPRequests содержит массив объектов SampledHTTPRequest.

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

Сложный тип, содержащий подробную информацию о запросе.

ClientIP -> (строка)

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

c-ip, если пользователь не использовал HTTP-прокси или балансировщик нагрузки для отправки запроса
x-forwarded-for, если пользователь использовал HTTP-прокси или балансировщик нагрузки для отправки запроса

Country -> (строка)

Двухбуквенный код страны происхождения запроса. Список кодов стран см. в записи Википедии ISO 3166-1 alpha-2.

URI -> (строка)

Путь URI запроса, идентифицирующий ресурс, например, /images/daily-ad.jpg.

Method -> (строка)

HTTP-метод, указанный в проанализированном веб-запросе.

HTTPVersion -> (строка)

Версия HTTP, указанная в проанализированном веб-запросе, например, HTTP/1.1.

Headers -> (список)

Сложный тип, содержащий имя и значение каждого заголовка в проанализированном веб-запросе.

(структура)

Часть ответа от GetSampledRequests. Это сложный тип, который отображается как Headers в синтаксисе ответа. HTTPHeader содержит имена и значения всех заголовков, присутствующих в одном из веб-запросов.

Name -> (строка)

Имя HTTP-заголовка.

Value -> (строка)

Значение HTTP-заголовка.

Weight -> (целое число без знака)

Значение, указывающее, как один результат в ответе соотносится пропорционально с другими результатами в ответе. Например, результат с весом 2 примерно в два раза больше веб-запросов, чем результат с весом 1.

Timestamp -> (метка времени)

Время получения запроса WAF от вашего ресурса Amazon Web Services в формате Unix (в секундах).

Action -> (строка)

Действие, применённое WAF к запросу.

RuleNameWithinRuleGroup -> (строка)

Имя Rule, которому соответствовал запрос. Для управляемых групп правил формат имени — <vendor name>#<managed rule group name>#<rule name>. Для собственных групп правил формат имени — <rule group name>#<rule name>. Если правило не находится в группе правил, это поле отсутствует.

RequestHeadersInserted -> (список)

Пользовательские заголовки запроса, добавленные WAF в запрос в соответствии с пользовательской конфигурацией запроса для действия сопоставленного правила.

(структура)

Name -> (строка)

Имя HTTP-заголовка.

Value -> (строка)

Значение HTTP-заголовка.

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

Код ответа, отправленный для запроса.

Labels -> (список)

Метки, применённые к веб-запросу соответствующими правилами. WAF применяет полные метки к соответствующим веб-запросам. Полная метка — это конкатенация пространства имён метки и метки правила. Пространство имён метки определено группой правил или веб-ACL правила.

Например, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA или awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

(структура)

Контейнер одной метки. Используется как элемент массива меток в нескольких контекстах, например, в RuleLabels внутри правила и в Labels внутри SampledHTTPRequest.

Name -> (строка)

Строка метки.

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

Ответ CAPTCHA для запроса.

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

Код HTTP-ответа, указывающий статус токена CAPTCHA в веб-запросе. Если токен отсутствует, недействителен или истек, этот код равен 405 Method Not Allowed.

SolveTimestamp -> (целое число без знака)

Время последнего решения для предоставленного токена CAPTCHA.

FailureReason -> (строка)

Причина ошибки, заполняется при ошибке проверки токена.

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

Ответ Challenge для запроса.

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

Код HTTP-ответа, указывающий статус токена вызова в веб-запросе. Если токен отсутствует, недействителен или истек, этот код равен 202 Request Accepted.

SolveTimestamp -> (целое число без знака)

Время последнего решения для предоставленного токена.

FailureReason -> (строка)

Причина ошибки, заполняется при ошибке проверки токена.

OverriddenAction -> (строка)

Используется только для правил группы правил, для которых в веб-ACL задано переопределение действия правила. Это действие, для которого настроено правило группы правил, а не действие, которое было применено к запросу. Действие, применённое WAF, — это значение Action.

PopulationSize -> (целое число без знака)

Общее количество запросов, из которых GetSampledRequests получил выборку из MaxItems запросов. Если PopulationSize меньше MaxItems, выборка включает каждый запрос, который ваш ресурс Amazon Web Services получил в указанный период.

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

Обычно TimeWindow — это интервал времени, указанный в запросе GetSampledRequests. Однако, если ваш ресурс Amazon Web Services получил более 5000 запросов в указанный в запросе интервал времени, GetSampledRequests возвращает интервал времени для первых 5000 запросов. Время указано в формате UTC.

StartTime -> (метка времени)

Начало интервала времени, из которого вы хотите, чтобы GetSampledRequests вернул выборку запросов, полученных вашим ресурсом Amazon Web Services. Время необходимо указать в формате UTC. Формат UTC включает специальный идентификатор Z. Например, "2016-09-27T14:50Z". Вы можете указать любой интервал времени в течение последних трёх часов.

EndTime -> (метка времени)

Конец интервала времени, из которого вы хотите, чтобы GetSampledRequests вернул выборку запросов, полученных вашим ресурсом Amazon Web Services. Время необходимо указать в формате UTC. Формат UTC включает специальный идентификатор Z. Например, "2016-09-27T14:50Z". Вы можете указать любой интервал времени в течение последних трёх часов.

END_OF_DOCUMENT_MARKER