get-relational-databases
Описание
Возвращает информацию обо всех базах данных в Amazon Lightsail.
См. также: Документацию API AWS
get-relational-databases является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлечь данные из результатов следующих выражений запроса: relationalDatabases
Синтаксис
get-relational-databases
[--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]
Параметры
--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
- таблица
- 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.
Для получения информации обо всех реляционных базах данных
Следующий пример get-relational-databases отображает данные обо всех реляционных базах данных в настроенном регионе AWS.
aws lightsail get-relational-databases
Вывод:
{
"relationalDatabases": [
{
"name": "MySQL",
"arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/8529020c-3ab9-4d51-92af-5EXAMPLE8979",
"supportCode": "6EXAMPLE3362/ls-3EXAMPLEa995d8c3b06b4501356e5f2f28e1aeba",
"createdAt": 1554306019.155,
"location": {
"availabilityZone": "us-west-2a",
"regionName": "us-west-2"
},
"resourceType": "RelationalDatabase",
"tags": [],
"relationalDatabaseBlueprintId": "mysql_8_0",
"relationalDatabaseBundleId": "micro_1_0",
"masterDatabaseName": "dbmaster",
"hardware": {
"cpuCount": 1,
"diskSizeInGb": 40,
"ramSizeInGb": 1.0
},
"state": "available",
"backupRetentionEnabled": true,
"pendingModifiedValues": {},
"engine": "mysql",
"engineVersion": "8.0.15",
"latestRestorableTime": 1571686200.0,
"masterUsername": "dbmasteruser",
"parameterApplyStatus": "in-sync",
"preferredBackupWindow": "07:51-08:21",
"preferredMaintenanceWindow": "tue:12:18-tue:12:48",
"publiclyAccessible": true,
"masterEndpoint": {
"port": 3306,
"address": "ls-3EXAMPLEa995d8c3b06b4501356e5f2fEXAMPLEa.czowadgeezqi.us-west-2.rds.amazonaws.com"
},
"pendingMaintenanceActions": []
},
{
"name": "Postgres",
"arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/e9780b6b-d0ab-4af2-85f1-1EXAMPLEac68",
"supportCode": "6EXAMPLE3362/ls-3EXAMPLEb4fffb5cec056220c734713e14bd5fcd",
"createdAt": 1554306000.814,
"location": {
"availabilityZone": "us-west-2a",
"regionName": "us-west-2"
},
"resourceType": "RelationalDatabase",
"tags": [],
"relationalDatabaseBlueprintId": "postgres_11",
"relationalDatabaseBundleId": "micro_1_0",
"masterDatabaseName": "dbmaster",
"hardware": {
"cpuCount": 1,
"diskSizeInGb": 40,
"ramSizeInGb": 1.0
},
"state": "available",
"backupRetentionEnabled": true,
"pendingModifiedValues": {},
"engine": "postgres",
"engineVersion": "11.1",
"latestRestorableTime": 1571686339.0,
"masterUsername": "dbmasteruser",
"parameterApplyStatus": "in-sync",
"preferredBackupWindow": "06:19-06:49",
"preferredMaintenanceWindow": "sun:10:19-sun:10:49",
"publiclyAccessible": false,
"masterEndpoint": {
"port": 5432,
"address": "ls-3EXAMPLEb4fffb5cec056220c734713eEXAMPLEd.czowadgeezqi.us-west-2.rds.amazonaws.com"
},
"pendingMaintenanceActions": []
}
]
}
Вывод
relationalDatabases -> (список)
Объект, описывающий результат запроса get relational databases.
(структура)
Описание базы данных.
name -> (строка)
arn -> (строка)
supportCode -> (строка)
createdAt -> (временная метка)
location -> (структура)
Имя региона и зона доступности, где расположена база данных.
availabilityZone -> (строка)
us-east-2a (регистрозависимый).regionName -> (строка)
resourceType -> (строка)
RelationalDatabase).tags -> (список)
Ключи тегов и необязательные значения для ресурса. Дополнительная информация о тегах в Lightsail доступна в руководстве разработчика Amazon Lightsail.
(структура)
Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.
Дополнительная информация о тегах в Lightsail доступна в руководстве разработчика Amazon Lightsail.
key -> (строка)
Ключ тега.
Ограничения: ключи тегов принимают максимум 128 символов, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @
value -> (строка)
Значение тега.
Ограничения: значения тегов принимают максимум 256 символов, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @
relationalDatabaseBlueprintId -> (строка)
relationalDatabaseBundleId -> (строка)
masterDatabaseName -> (строка)
hardware -> (структура)
Описание аппаратного обеспечения базы данных.
cpuCount -> (целое число)
diskSizeInGb -> (целое число)
ramSizeInGb -> (вещественное число)
state -> (строка)
secondaryAvailabilityZone -> (строка)
Описание вторичной зоны доступности базы данных с высокой доступностью.
Вторичная база данных используется для поддержки аварийного переключения (failover) базы данных с высокой доступностью.
backupRetentionEnabled -> (булево значение)
pendingModifiedValues -> (структура)
Описание ожидающих изменений значений базы данных.
masterUserPassword -> (строка)
engineVersion -> (строка)
backupRetentionEnabled -> (булево значение)
engine -> (строка)
MySQL).engineVersion -> (строка)
5.7.23).latestRestorableTime -> (временная метка)
masterUsername -> (строка)
parameterApplyStatus -> (строка)
preferredBackupWindow -> (строка)
16:00-16:30).preferredMaintenanceWindow -> (строка)
Еженедельный интервал времени, в течение которого может выполняться техническое обслуживание системы базы данных.
Формат ddd:hh24:mi-ddd:hh24:mi. Например, Tue:17:00-Tue:17:30.
publiclyAccessible -> (булево значение)
masterEndpoint -> (структура)
Основной конечный пункт (endpoint) базы данных.
port -> (целое число)
address -> (строка)
pendingMaintenanceActions -> (список)
Описание ожидающих действий технического обслуживания для базы данных.
(структура)
Описание ожидающего действия технического обслуживания базы данных.
action -> (строка)
description -> (строка)
currentApplyDate -> (временная метка)
caCertificateIdentifier -> (строка)
nextPageToken -> (строка)
Токен для перехода к следующей странице результатов вашего запроса.
Токен следующей страницы не возвращается, если больше результатов отобразить нечего.
Для получения следующей страницы результатов выполните еще один запрос GetRelationalDatabases и укажите токен следующей страницы с помощью параметра pageToken.
© Copyright 2025, Amazon Web Services. Created using Sphinx.