describe-db-proxy-targets
Описание
Возвращает информацию об объектах DBProxyTarget. Этот API поддерживает пагинацию.
См. также: Документация AWS API
describe-db-proxy-targets является операцией с пагинацией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить пагинацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией аргумент --query должен извлекать данные из результатов следующих выражений запроса: Targets
Синтаксис
describe-db-proxy-targets
--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 (строка)
DBProxyTarget для описания.--target-group-name (строка)
DBProxyTargetGroup для описания.--filters (список)
Этот параметр в настоящее время не поддерживается.
(структура)
Пара имя-значение фильтра, используемый для возвращения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как идентификаторы. Поддерживаемые фильтры для операции describe документированы вместе с этой операцией.
Примечание
В настоящее время в фильтрах не поддерживаются подстановочные знаки.Можно фильтровать следующие действия:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribeDBRecommendationsDescribeDBShardGroupsDescribePendingMaintenanceActions
Имя -> (строка)
Значения -> (список)
Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.
(строка)
Сокращенный синтаксис:
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 CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов AWS-сервиса.
Примеры использования см. в разделе Пагинация в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды будет предоставлен NextToken. Для возобновления пагинации предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Пагинация в руководстве пользователя AWS CLI.
--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 (строка)
Включить/выключить цветной вывод.
- вкл
- выкл
- авто
--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.
Для описания целей DB прокси
Следующий пример describe-db-proxy-targets возвращает информацию о целях DB прокси.
aws rds describe-db-proxy-targets \
--db-proxy-name proxyExample
Вывод:
{
"Targets": [
{
"Endpoint": "database1.ab0cd1efghij.us-east-1.rds.amazonaws.com",
"TrackedClusterId": "database1",
"RdsResourceId": "database1-instance-1",
"Port": 3306,
"Type": "RDS_INSTANCE",
"Role": "READ_WRITE",
"TargetHealth": {
"State": "UNAVAILABLE",
"Reason": "PENDING_PROXY_CAPACITY",
"Description": "DBProxy Target is waiting for proxy to scale to desired capacity"
}
}
]
}
Дополнительную информацию см. в разделах Просмотр прокси RDS в руководстве пользователя Amazon RDS и Просмотр прокси RDS в руководстве пользователя Amazon Aurora.
Вывод
Цели -> (список)
Произвольное количество объектов DBProxyTarget, содержащих подробности соответствующих целей.
(структура)
Содержит подробности целевого объекта RDS Proxy. Представляет экземпляр базы данных RDS или кластер баз данных Aurora, к которому прокси может подключиться. Один или несколько целевых объектов связаны с группой целевых объектов RDS Proxy.
Этот тип данных используется в качестве элемента ответа в действии DescribeDBProxyTargets.
TargetArn -> (строка)
Endpoint -> (строка)
TrackedClusterId -> (строка)
RdsResourceId -> (строка)
Порт -> (целое число)
Тип -> (строка)
Роль -> (строка)
TargetHealth -> (структура)
Информация о состоянии соединения целевого объекта RDS Proxy.
Состояние -> (строка)
Текущее состояние жизненного цикла состояния соединения для целевого объекта RDS Proxy. Ниже приведен типичный пример жизненного цикла состояний целевого объекта RDS Proxy:
registering > unavailable > available > unavailable > available
Причина -> (строка)
State целевого объекта RDS Proxy.Описание -> (строка)
State равно AVAILABLE, описание не включено.Маркер -> (строка)
MaxRecords.
© Copyright 2025, Amazon Web Services. Created using Sphinx.