describe-db-proxy-endpoints
Описание
Возвращает информацию о конечных точках прокси-сервера базы данных.
См. также: Документацию API AWS
describe-db-proxy-endpoints является постраничной операцией. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DBProxyEndpoints
Синтаксис
describe-db-proxy-endpoints
[--db-proxy-name <value>]
[--db-proxy-endpoint-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 (строка)
--db-proxy-endpoint-name (строка)
--filters (список)
Этот параметр в настоящее время не поддерживается.
(структура)
Пара имя-значение фильтра, используемый для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как идентификаторы. Поддерживаемые фильтры операции 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 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
- текст
- таблица
- 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-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования типа Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для описания конечных точек прокси-сервера базы данных
Следующий describe-db-proxy-endpoints пример возвращает информацию о конечных точках прокси-сервера базы данных.
aws rds describe-db-proxy-endpoints
Вывод:
{
"DBProxyEndpoints": [
{
"DBProxyEndpointName": "proxyEndpoint1",
"DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
"DBProxyName": "proxyExample",
"Status": "available",
"VpcId": "vpc-1234567",
"VpcSecurityGroupIds": [
"sg-1234"
],
"VpcSubnetIds": [
"subnetgroup1",
"subnetgroup2"
],
"Endpoint": "proxyEndpoint1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
"CreatedDate": "2023-04-05T16:09:33.452000+00:00",
"TargetRole": "READ_WRITE",
"IsDefault": false
},
{
"DBProxyEndpointName": "proxyEndpoint2",
"DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-4567a01b12345c0ab",
"DBProxyName": "proxyExample2",
"Status": "available",
"VpcId": "vpc1234567",
"VpcSecurityGroupIds": [
"sg-5678"
],
"VpcSubnetIds": [
"subnetgroup1",
"subnetgroup2"
],
"Endpoint": "proxyEndpoint2.endpoint.proxy-cd1ef2klmnop.us-east-1.rds.amazonaws.com",
"CreatedDate": "2023-04-05T16:09:33.452000+00:00",
"TargetRole": "READ_WRITE",
"IsDefault": false
}
]
}
Дополнительную информацию см. в разделах Просмотр конечной точки прокси в Руководстве пользователя Amazon RDS и Создание конечной точки прокси в Руководстве пользователя Amazon Aurora.
Вывод
DBProxyEndpoints -> (список)
Список объектов ProxyEndpoint, возвращаемых операцией API.
(структура)
Структура данных, представляющая конечную точку, связанную с прокси-сервером базы данных. RDS автоматически создает одну конечную точку для каждого прокси-сервера базы данных. Для кластеров баз данных Aurora можно связать дополнительные конечные точки с тем же прокси-сервером. Эти конечные точки могут быть чтение/запись или только чтение. Они также могут находиться в разных VPC, чем связанный с ними прокси-сервер.
Этот тип данных используется в качестве элемента ответа в операции DescribeDBProxyEndpoints.
DBProxyEndpointName -> (строка)
DBProxyEndpointArn -> (строка)
DBProxyName -> (строка)
Статус -> (строка)
available означает, что конечная точка готова обрабатывать запросы. Другие значения указывают, что вам нужно подождать, пока конечная точка станет готовой, или предпринять какие-либо действия для решения проблемы.VpcId -> (строка)
VpcSecurityGroupIds -> (список)
Список VPC-групп безопасности, к которым принадлежит конечная точка прокси-сервера базы данных.
(строка)
VpcSubnetIds -> (список)
Идентификаторы EC2-подсетей для конечной точки прокси-сервера базы данных.
(строка)
Конечная точка -> (строка)
CreatedDate -> (временная метка)
TargetRole -> (строка)
IsDefault -> (логическое значение)
Маркер -> (строка)
MaxRecords.
© Copyright 2025, Amazon Web Services. Created using Sphinx.