Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

получить-набор-ip

Описание

Получает указанный набор IP-адресов.

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

Синтаксис

  get-ip-set
--name <value>
--scope <value>
--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]

Параметры

--name (строка)

Имя набора IP-адресов. Вы не можете изменить имя набора IPSet после его создания.

--scope (строка)

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

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

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

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

  • CLOUDFRONT
  • REGIONAL

--id (строка)

Уникальный идентификатор набора. Этот идентификатор возвращается в ответах на команды создания и перечисления. Вы используете его для операций обновления и удаления.

--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
  • текст
  • таблица
  • 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.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров входных данных CLI.

Примеры

Примечание

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

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

Для получения определенного набора IP-адресов

Следующий пример получает набор IP-адресов с указанным именем, областью и идентификатором. Вы можете получить идентификатор набора IP-адресов из команд create-ip-set и list-ip-sets.

aws wafv2 get-ip-set \
    --name testip \
    --scope REGIONAL \
    --id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "IPSet":{
        "Description":"",
        "Name":"testip",
        "IPAddressVersion":"IPV4",
        "Id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE1111",
        "ARN":"arn:aws:wafv2:us-west-2:123456789012:regional/ipset/testip/a1b2c3d4-5678-90ab-cdef-EXAMPLE1111",
        "Addresses":[
            "192.0.2.0/16"
        ]
    },
    "LockToken":"447e55ac-2396-4c6d-b9f9-86b67c17f8b5"
}

Дополнительную информацию см. в разделах «Наборы IP-адресов и наборы шаблонов регулярных выражений» в Руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

Набор IP-адресов -> (структура)

Имя -> (строка)

Имя набора IP-адресов. Вы не можете изменить имя набора IPSet после его создания.

Идентификатор -> (строка)

Уникальный идентификатор набора. Этот идентификатор возвращается в ответах на команды создания и перечисления. Вы используете его для операций обновления и удаления.

ARN -> (строка)

Amazon Resource Name (ARN) сущности.

Описание -> (строка)

Описание набора IP-адресов, помогающее в идентификации.

Версия IP-адресов -> (строка)

Версия IP-адресов, либо IPV4, либо IPV6.

Адреса -> (список)

Содержит массив строк, определяющий ноль или более IP-адресов или блоков IP-адресов, которые WAF должен проверять на входящие запросы. Все адреса должны быть указаны в формате CIDR (Classless Inter-Domain Routing). WAF поддерживает все IPv4 и IPv6 диапазоны CIDR, за исключением /0.

Примеры строк адресов:

  • Для запросов, исходящих от IP-адреса 192.0.2.44, укажите 192.0.2.44/32.
  • Для запросов, исходящих от IP-адресов от 192.0.2.0 до 192.0.2.255, укажите 192.0.2.0/24.
  • Для запросов, исходящих от IP-адреса 1111:0000:0000:0000:0000:0000:0000:0111, укажите 1111:0000:0000:0000:0000:0000:0000:0111/128.
  • Для запросов, исходящих от IP-адресов от 1111:0000:0000:0000:0000:0000:0000:0000 до 1111:0000:0000:0000:ffff:ffff:ffff:ffff, укажите 1111:0000:0000:0000:0000:0000:0000:0000/64.

Дополнительную информацию о формате CIDR см. в статье Википедии «Маршрутизация между доменами без класса».

Примеры JSON Addresses спецификаций:

  • Пустой массив: "Addresses": []
  • Массив с одним адресом: "Addresses": ["192.0.2.44/32"]
  • Массив с тремя адресами: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
  • НЕВЕРНАЯ спецификация: "Addresses": [""] НЕВЕРНО

(строка)

Маркер блокировки -> (строка)

Маркер, используемый для оптимистической блокировки. WAF возвращает маркер в ваш get и list запросы, чтобы отметить состояние сущности на момент запроса. Чтобы внести изменения в сущность, связанную с маркером, вы предоставляете маркер операциям, таким как update и delete. WAF использует маркер, чтобы гарантировать, что в сущность не были внесены изменения с момента последнего извлечения. Если изменения были внесены, обновление завершается с WAFOptimisticLockException. В этом случае выполните еще один get и используйте новый маркер, возвращённый этой операцией.

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

Spec-Zone.ru

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