Spec-Zone.ru › AWS CLI v2

[ aws . elbv2 ]

describe-rules

Описание

Описывает указанные правила или правила для указанного слушателя. Вы должны указать либо слушателя, либо одно или несколько правил.

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

describe-rules является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Rules

Синтаксис

  describe-rules
[--listener-arn <value>]
[--rule-arns <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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-arn (строка)

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

--rule-arns (список)

Amazon Resource Names (ARN) правил.

(строка)

Синтаксис:

"string" "string" ...

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

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

--starting-token (строка)

Токен для указания места начала постраничного вывода. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Пример 1: Описание правила

Следующий describe-rules пример отображает подробности указанного правила.

aws elbv2 describe-rules \
    --rule-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee

Пример 2: Описание правил для слушателя

Следующий describe-rules пример отображает подробности правил для указанного слушателя. Вывод включает правило по умолчанию и любые другие добавленные правила.

aws elbv2 describe-rules \
    --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2

Вывод

Правила -> (список)

Информация о правилах.

(структура)

Информация о правиле.

RuleArn -> (строка)

Идентификатор ресурса Amazon (ARN) правила.

Priority -> (строка)

Приоритет.

Conditions -> (список)

Условие. Каждое правило может включать ноль или одно из следующих условий: http-request-method , host-header , path-pattern , и source-ip , и ноль или более из следующих условий: http-header и query-string .

(структура)

Информация об условии правила.

Каждое правило может необязательно включать до одного из следующих условий: http-request-method , host-header , path-pattern , и source-ip . Каждое правило также может необязательно включать один или более из следующих условий: http-header и query-string . Обратите внимание, что значение условия не может быть пустым.

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

Field -> (строка)

Поле в HTTP-запросе. Следующие являются возможными значениями:

  • http-header
  • http-request-method
  • host-header
  • path-pattern
  • query-string
  • source-ip

Values -> (список)

Значение условия. Указывается только тогда, когда Field равно host-header или path-pattern . В качестве альтернативы, для указания нескольких имен хостов или нескольких шаблонов путей используйте HostHeaderConfig или PathPatternConfig .

Если Field равно host-header и вы не используете HostHeaderConfig , вы можете указать одно имя хоста (например, my.example.com) в Values . Имя хоста не чувствительно к регистру, может иметь длину до 128 символов и может содержать любые из следующих символов.

  • A-Z, a-z, 0-9
    • .
    • (соответствует 0 или более символам)
  • ? (соответствует ровно 1 символу)

Если Field равно path-pattern и вы не используете PathPatternConfig , вы можете указать один шаблон пути (например, /img/*) в Values . Шаблон пути чувствителен к регистру, может иметь длину до 128 символов и может содержать любые из следующих символов.

  • A-Z, a-z, 0-9
  • _ - . $ / ~ “ ‘ @ : +
  • & (используя &amp;)
    • (соответствует 0 или более символам)
  • ? (соответствует ровно 1 символу)

(строка)

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

Информация для условия имени хоста. Указывается только тогда, когда Field равно host-header .

Values -> (список)

Имена хостов. Максимальный размер каждого имени — 128 символов. Сравнение не учитывает регистр. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу).

Если вы указываете несколько строк, условие выполняется, если одно из них соответствует имени хоста.

(строка)

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

Информация для условия шаблона пути. Указывается только тогда, когда Field равно path-pattern .

Values -> (список)

Шаблоны путей для сравнения с URL-адресом запроса. Максимальный размер каждой строки — 128 символов. Сравнение учитывает регистр. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу).

Если вы указываете несколько строк, условие выполняется, если одно из них соответствует URL-адресу запроса. Шаблон пути сравнивается только с путем URL-адреса, а не с его строкой запроса. Чтобы сравнить со строкой запроса, используйте QueryStringConditionConfig .

(строка)

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

Информация для условия HTTP-заголовка. Указывается только тогда, когда Field равно http-header .

HttpHeaderName -> (строка)

Имя поля HTTP-заголовка. Максимальный размер — 40 символов. Имя заголовка нечувствительно к регистру. Допустимые символы определяются RFC 7230. Символы подстановки не поддерживаются.

Вы не можете использовать условие HTTP-заголовка для указания заголовка хоста. Используйте HostHeaderConditionConfig для указания условия заголовка хоста.

Values -> (список)

Строки для сравнения со значением HTTP-заголовка. Максимальный размер каждой строки — 128 символов. Строки сравнения нечувствительны к регистру. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу).

Если один и тот же заголовок появляется несколько раз в запросе, мы ищем их в порядке, пока не найдем соответствие.

Если вы указываете несколько строк, условие выполняется, если одна из них соответствует значению HTTP-заголовка. Чтобы потребовать, чтобы все строки совпадали, создайте одно условие на каждую строку.

(строка)

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

Информация для условия строки запроса. Указывается только тогда, когда Field равно query-string .

Values -> (список)

Ключи/значения или значения для поиска в строке запроса. Максимальный размер каждой строки — 128 символов. Сравнение не учитывает регистр. Поддерживаются следующие символы подстановки: * (соответствует 0 или более символам) и ? (соответствует ровно 1 символу). Чтобы найти в строке запроса символ «*» или «?», необходимо экранировать эти символы в Values с помощью символа «'».

Если вы указываете несколько пар ключ/значение или значений, условие выполняется, если одно из них найдено в строке запроса.

(структура)

Информация о паре ключ/значение.

Key -> (строка)

Ключ. Вы можете опустить ключ.

Value -> (строка)

Значение.

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

Информация для условия HTTP-метода. Указывается только тогда, когда Field равно http-request-method .

Values -> (список)

Название метода запроса. Максимальный размер — 40 символов. Допустимые символы — A-Z, дефис (-) и подчёркивание (_). Сравнение учитывает регистр. Символы подстановки не поддерживаются, поэтому имя метода должно точно совпадать.

Если вы указываете несколько строк, условие выполняется, если одна из строк соответствует методу HTTP-запроса. Рекомендуется обрабатывать запросы GET и HEAD одинаково, так как ответ на запрос HEAD может быть кэширован.

(строка)

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

Информация для условия IP-адреса источника. Указывается только тогда, когда Field равно source-ip .

Values -> (список)

IP-адреса источника в формате CIDR. Можно использовать как IPv4, так и IPv6 адреса. Символы подстановки не поддерживаются.

Если вы указываете несколько адресов, условие выполняется, если IP-адрес источника запроса соответствует одному из блоков CIDR. Это условие не выполняется для адресов в заголовке X-Forwarded-For. Чтобы искать адреса в заголовке X-Forwarded-For, используйте HttpHeaderConditionConfig .

Общее количество значений должно быть меньше или равно пяти.

(строка)

Actions -> (список)

Действия. Каждое правило должно содержать ровно один из следующих типов действий: forward , redirect , или fixed-response , и это должно быть последнее выполняемое действие.

(структура)

Информация об действии.

Каждое правило должно содержать ровно один из следующих типов действий: forward , fixed-response , или redirect , и это должно быть последнее выполняемое действие.

Тип -> (строка)

Тип действия.

TargetGroupArn -> (строка)

Amazon Resource Name (ARN) целевой группы. Указывается только тогда, когда Type является forward и вы хотите маршрутизировать трафик на одну целевую группу. Для маршрутизации на одну или несколько целевых групп используйте ForwardConfig.

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

[HTTPS-листенеры] Информация об поставщике удостоверений, совместимом с OpenID Connect (OIDC). Указывается только тогда, когда Type является authenticate-oidc.

Issuer -> (строка)

Идентификатор издателя OIDC IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

AuthorizationEndpoint -> (строка)

Конечная точка авторизации IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

TokenEndpoint -> (строка)

Конечная точка получения токена IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

UserInfoEndpoint -> (строка)

Конечная точка получения информации о пользователе IdP. Должен быть полным URL-адресом, включая протокол HTTPS, домен и путь.

ClientId -> (строка)

Идентификатор клиента OAuth 2.0.

ClientSecret -> (строка)

Секрет клиента OAuth 2.0. Этот параметр обязателен при создании правила. При изменении правила вы можете опустить этот параметр, если установите UseExistingClientSecret в значение true.

SessionCookieName -> (строка)

Имя куки, используемой для сохранения информации о сеансе. По умолчанию AWSELBAuthSessionCookie.

Scope -> (строка)

Набор пользовательских утверждений, которые необходимо запросить у IdP. По умолчанию openid.

Для проверки поддерживаемых IdP значений scope и разделения нескольких значений см. документацию вашего IdP.

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

Максимальная продолжительность сеанса аутентификации в секундах. По умолчанию 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (массив)

Параметры запроса (до 10) для включения в запросе перенаправления на конечную точку авторизации.

ключ -> (строка)

значение -> (строка)

OnUnauthenticatedRequest -> (строка)

Действие при отсутствии аутентификации пользователя. Возможные значения:

  • deny- Вернуть ошибку HTTP 401 Unauthorized.
  • allow- Разрешить перенаправление запроса на целевой сервер.
  • authenticate- Перенаправить запрос на конечную точку авторизации IdP. Это значение по умолчанию.

UseExistingClientSecret -> (булево)

Указывает, использовать ли существующий секрет клиента при изменении правила. При создании правила вы можете опустить этот параметр или установить его в false.

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

[HTTPS-листенеры] Информация для использования Amazon Cognito для аутентификации пользователей. Указывается только тогда, когда Type является authenticate-cognito.

UserPoolArn -> (строка)

Amazon Resource Name (ARN) пула пользователей Amazon Cognito.

UserPoolClientId -> (строка)

Идентификатор клиента пула пользователей Amazon Cognito.

UserPoolDomain -> (строка)

Префикс домена или полное доменное имя пула пользователей Amazon Cognito.

SessionCookieName -> (строка)

Имя куки, используемой для сохранения информации о сеансе. По умолчанию AWSELBAuthSessionCookie.

Scope -> (строка)

Набор пользовательских утверждений, которые необходимо запросить у IdP. По умолчанию openid.

Для проверки поддерживаемых IdP значений scope и разделения нескольких значений см. документацию вашего IdP.

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

Максимальная продолжительность сеанса аутентификации в секундах. По умолчанию 604800 секунд (7 дней).

AuthenticationRequestExtraParams -> (массив)

Параметры запроса (до 10) для включения в запросе перенаправления на конечную точку авторизации.

ключ -> (строка)

значение -> (строка)

OnUnauthenticatedRequest -> (строка)

Действие при отсутствии аутентификации пользователя. Возможные значения:

  • deny- Вернуть ошибку HTTP 401 Unauthorized.
  • allow- Разрешить перенаправление запроса на целевой сервер.
  • authenticate- Перенаправить запрос на конечную точку авторизации IdP. Это значение по умолчанию.

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

Порядок выполнения действия. Требуется для правил с несколькими действиями. Действие с наименьшим значением order выполняется первым.

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

[Application Load Balancer] Информация для создания действия перенаправления. Указывается только тогда, когда Type является redirect.

Protocol -> (строка)

Протокол. Можно указать HTTP, HTTPS или #{protocol}. Можно перенаправлять HTTP на HTTP, HTTP на HTTPS и HTTPS на HTTPS. Перенаправление HTTPS на HTTP недоступно.

Port -> (строка)

Порт. Можно указать значение от 1 до 65535 или #{port}.

Host -> (строка)

Имя хоста. Эта часть не кодируется в проценты. Имя хоста может содержать #{host}.

Path -> (строка)

Абсолютный путь, начинающийся с ведущей “/”. Эта часть не кодируется в проценты. Путь может содержать #{host}, #{path} и #{port}.

Query -> (строка)

Параметры запроса, кодированные по URL при необходимости, но не закодированные в проценты. Не включайте ведущую “?”, так как она добавляется автоматически. Вы можете указать любые зарезервированные слова.

StatusCode -> (строка)

Код HTTP перенаправления. Перенаправление может быть постоянным (HTTP 301) или временным (HTTP 302).

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

[Application Load Balancer] Информация для создания действия, возвращающего пользовательский HTTP-ответ. Указывается только тогда, когда Type является fixed-response.

MessageBody -> (строка)

Сообщение.

StatusCode -> (строка)

Код HTTP ответа (2XX, 4XX или 5XX).

ContentType -> (строка)

Тип содержимого.

Допустимые значения: text/plain | text/css | text/html | application/javascript | application/json

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

Информация для создания действия, распределяющего запросы между одной или несколькими целевыми группами. Для Network Load Balancers можно указать одну целевую группу. Указывается только тогда, когда Type является forward. Если вы указываете и ForwardConfig, и TargetGroupArn, вы можете указать только одну целевую группу, используя ForwardConfig, и она должна быть той же целевой группой, что и в TargetGroupArn.

TargetGroups -> (список)

Целевые группы. Для Network Load Balancers можно указать одну целевую группу.

(структура)

Информация о том, как трафик будет распределяться между несколькими целевыми группами в правиле перенаправления.

TargetGroupArn -> (строка)

Amazon Resource Name (ARN) целевой группы.

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

Вес. Диапазон 0-999.

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

Настройка привязки к целевой группе для правила.

Enabled -> (булево)

Указывает, включена ли привязка к целевой группе.

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

Период времени в секундах, в течение которого запросы от клиента должны быть направлены в ту же целевую группу. Диапазон 1-604800 секунд (7 дней).

IsDefault -> (булево)

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

NextMarker -> (строка)

Если существуют дополнительные результаты, это маркер для следующего набора результатов. В противном случае это null.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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