Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-db-proxy-target-groups

Описание

Возвращает информацию о целевых группах прокси-сервера БД, представленных структурами данных DBProxyTargetGroup.

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

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

Синтаксис

  describe-db-proxy-target-groups
--db-proxy-name <value>
[--target-group-name <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]

Параметры

--db-proxy-name (строка)

Идентификатор DBProxy, связанного с целевой группой.

--target-group-name (строка)

Идентификатор DBProxyTargetGroup, который нужно описать.

--filters (список)

Этот параметр в настоящее время не поддерживается.

(структура)

Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как идентификаторы. Поддерживаемые фильтры для операции describe документированы в описании этой операции.

Примечание

В настоящее время в фильтрах не поддерживаются подстановочные знаки.

Следующие действия могут быть отфильтрованы:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

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

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

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

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

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

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

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

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

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

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

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

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

Примеры

Примечание

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

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

Для описания конечных точек прокси-сервера БД

Следующий пример describe-db-proxy-target-groups возвращает информацию о целевых группах прокси-сервера БД.

aws rds describe-db-proxy-target-groups \
    --db-proxy-name proxyExample

Вывод:

{
"TargetGroups":
    {
        "DBProxyName": "proxyExample",
        "TargetGroupName": "default",
        "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab",
        "IsDefault": true,
        "Status": "available",
        "ConnectionPoolConfig": {
            "MaxConnectionsPercent": 100,
            "MaxIdleConnectionsPercent": 50,
            "ConnectionBorrowTimeout": 120,
            "SessionPinningFilters": []
        },
        "CreatedDate": "2023-05-02T18:41:19.495000+00:00",
        "UpdatedDate": "2023-05-02T18:41:21.762000+00:00"
    }
}

Дополнительную информацию см. в разделе Просмотр прокси RDS в Руководстве пользователя Amazon RDS и Просмотр прокси RDS в Руководстве пользователя Amazon Aurora.

Вывод

TargetGroups -> (список)

Произвольное количество DBProxyTargetGroup объектов, содержащих подробности соответствующих целевых групп.

(структура)

Представляет набор экземпляров баз данных RDS, кластеров баз данных Aurora или их комбинацию, к которым может подключаться прокси. В настоящее время каждая целевая группа связана ровно с одним экземпляром базы данных RDS или кластером Aurora.

Этот тип данных используется в качестве элемента ответа в действии DescribeDBProxyTargetGroups.

DBProxyName -> (строка)

Идентификатор прокси RDS, связанного с этой целевой группой.

TargetGroupName -> (строка)

Идентификатор целевой группы. Это имя должно быть уникальным для всех целевых групп, принадлежащих вашей учетной записи Amazon Web Services в указанном регионе Amazon Web Services.

TargetGroupArn -> (строка)

Amazon Resource Name (ARN), представляющий целевую группу.

IsDefault -> (булево)

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

Status -> (строка)

Текущий статус этой целевой группы. Статус available означает, что целевая группа правильно связана с базой данных. Другие значения указывают на то, что вам необходимо дождаться готовности целевой группы или предпринять какие-либо действия для решения проблемы.

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

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

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

Максимальный размер пула подключений для каждого элемента в целевой группе. Значение выражается в процентах от значения max_connections для экземпляра базы данных RDS или кластера Aurora, используемого целевой группой.

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

Контролирует активность закрытия прокси неактивных подключений к базе данных в пуле подключений. Значение выражается в процентах от значения max_connections для экземпляра базы данных RDS или кластера Aurora, используемого целевой группой. Высокое значение означает, что прокси оставляет открытым высокий процент неактивных подключений к базе данных. Низкое значение заставляет прокси закрывать больше неактивных подключений и возвращать их базе данных.

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

Количество секунд, в течение которого прокси ожидает доступного подключения в пуле подключений. Применяется только тогда, когда прокси открыл максимальное количество подключений, и все подключения заняты сессиями клиентов.

SessionPinningFilters -> (список)

Каждый элемент списка представляет класс SQL-операций, которые обычно приводят к тому, что все последующие операторы в сессии, использующей прокси, привязываются к одному и тому же подключению к базе данных. Включение элемента в список исключает этот класс SQL-операций из поведения привязки. Этот параметр поддерживается только для баз данных семейства MySQL. В настоящее время единственное разрешенное значение — EXCLUDE_VARIABLE_SETS.

(строка)

InitQuery -> (строка)

Один или несколько SQL-запросов, которые прокси выполняет при открытии каждого нового подключения к базе данных. Обычно используется с SET операторами, чтобы убедиться, что каждое подключение имеет одинаковые настройки, такие как часовой пояс и набор символов. По умолчанию это значение пустое. Для нескольких операторов используйте точки с запятой в качестве разделителя. Вы также можете включить несколько переменных в одном операторе SET, например, SET x=1, y=2.

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

Дата и время создания целевой группы.

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

Дата и время последнего обновления целевой группы.

Marker -> (строка)

Необязательный маркер постраничной навигации, предоставленный предыдущим запросом. Если этот параметр указан, в ответе содержатся только записи, находящиеся за маркером, до значения, указанного в MaxRecords.

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

Spec-Zone.ru

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