describe-rds-db-instances
Описание
Описывает экземпляры Amazon RDS.
Этот вызов принимает только один параметр для идентификации ресурса.
См. также: Документацию API AWS
Синтаксис
describe-rds-db-instances
--stack-id <value>
[--rds-db-instance-arns <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]
Параметры
--stack-id (строка)
--rds-db-instance-arns (список)
Массив, содержащий ARNs экземпляров, которые необходимо описать.
(строка)
Синтаксис:
"string" "string" ...
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной программы. См. использование кавычек со строками в руководстве пользователя AWS CLI.
Чтобы описать зарегистрированные Amazon RDS экземпляры стека
Следующий пример описывает экземпляры Amazon RDS, зарегистрированные со указанным стеком.
aws opsworks --region us-east-1 describe-rds-db-instances --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06
Вывод: Ниже приведён вывод для стека с одним зарегистрированным экземпляром RDS.
{
"RdsDbInstances": [
{
"Engine": "mysql",
"StackId": "d72553d4-8727-448c-9b00-f024f0ba1b06",
"MissingOnRds": false,
"Region": "us-west-2",
"RdsDbInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:clitestdb",
"DbPassword": "*****FILTERED*****",
"Address": "clitestdb.cdlqlk5uwd0k.us-west-2.rds.amazonaws.com",
"DbUser": "cliuser",
"DbInstanceIdentifier": "clitestdb"
}
]
}
Дополнительную информацию см. в разделе Управление ресурсами в руководстве пользователя AWS OpsWorks.
Вывод
RdsDbInstances -> (список)
Массив объектов RdsDbInstance, описывающих экземпляры.
(структура)
Описывает экземпляр Amazon RDS.
RdsDbInstanceArn -> (строка)
DbInstanceIdentifier -> (строка)
DbUser -> (строка)
DbPassword -> (строка)
*****FILTERED***** вместо фактического значения.Region -> (строка)
Address -> (строка)
Engine -> (строка)
StackId -> (строка)
MissingOnRds -> (булево)
true, если OpsWorks Stacks не может обнаружить экземпляр Amazon RDS. OpsWorks Stacks пытается обнаружить экземпляр только один раз. Если это значение установлено в true, необходимо дезактивировать экземпляр и затем зарегистрировать его снова.
© Copyright 2025, Amazon Web Services. Created using Sphinx.