Spec-Zone.ru › AWS CLI v2

[ aws . vpc-lattice ]

get-rule

Описание

Извлекает информацию о заданных правилах слушателя. Также можно получить информацию о правиле слушателя по умолчанию. Дополнительную информацию см. в разделе Правила слушателей в руководстве пользователя Amazon VPC Lattice.

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

Синтаксис

  get-rule
--listener-identifier <value>
--rule-identifier <value>
--service-identifier <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]

Параметры

--listener-identifier (строка)

Идентификатор или ARN слушателя.

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

Идентификатор или ARN правила слушателя.

--service-identifier (строка)

Идентификатор или ARN сервиса.

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

Вывод

действие -> (структура помеченных объединений)

Действие для правила по умолчанию.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: fixedResponse, forward.

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

Действие фиксированного ответа. Правило возвращает пользовательский HTTP-ответ.

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

Код HTTP-ответа.

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

Действие переадресации. Трафик, соответствующий правилу, перенаправляется на указанные группы целевых узлов.

targetGroups -> (список)

Целевые группы. Трафик, соответствующий правилу, перенаправляется на указанные целевые группы. При действиях переадресации можно назначить вес, который контролирует приоритет и выбор каждой целевой группы. Это означает, что запросы распределяются по отдельным целевым группам на основе их весов. Например, если две целевые группы имеют одинаковый вес, каждая целевая группа получает половину трафика.

Значение по умолчанию равно 1. Это означает, что если указана только одна целевая группа, нет необходимости устанавливать вес; 100% трафика направляется в эту целевую группу.

(структура)

Описание веса целевой группы.

targetGroupIdentifier -> (строка)

Идентификатор или ARN целевой группы.

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

Требуется только если вы указываете несколько целевых групп для действия переадресации. Вес определяет, как запросы распределяются по целевой группе. Например, если вы указываете две целевые группы, каждая с весом 10, каждая целевая группа получает половину запросов. Если вы указываете две целевые группы, одна с весом 10, а другая с весом 20, целевая группа с весом 20 получает в два раза больше запросов, чем другая целевая группа. Если указана только одна целевая группа, значение по умолчанию равно 100.

arn -> (строка)

Amazon Resource Name (ARN) слушателя.

createdAt -> (временная метка)

Дата и время создания правила слушателя в формате ISO-8601.

id -> (строка)

Идентификатор слушателя.

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

Указывает, является ли это правилом по умолчанию.

lastUpdatedAt -> (временная метка)

Дата и время последнего обновления правила слушателя в формате ISO-8601.

match -> (структура помеченных объединений)

Соответствие правила.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: httpMatch.

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

HTTP-критерии, которым должно соответствовать правило.

headerMatches -> (список)

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

(структура)

Описание ограничений для соответствия заголовку. Сопоставляет входящие запросы с правилом на основе значения заголовка запроса перед применением действия правила.

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

Указывает, является ли соответствие чувствительным к регистру.

match -> (структура помеченных объединений)

Тип соответствия заголовку.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: contains, exact, prefix.

contains -> (строка)

Сопоставление типа содержит.

exact -> (строка)

Точное соответствие.

prefix -> (строка)

Префиксное соответствие. Сопоставляет значение с префиксом.

name -> (строка)

Название заголовка.

method -> (строка)

Тип HTTP-метода.

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

Соответствие пути.

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

Указывает, является ли соответствие чувствительным к регистру.

match -> (структура помеченных объединений)

Тип соответствия пути.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: exact, prefix.

exact -> (строка)

Точное соответствие пути.

prefix -> (строка)

Соответствие префиксу пути.

name -> (строка)

Название слушателя.

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

Уровень приоритета для указанного правила.

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

Spec-Zone.ru

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