Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

получить-базу-данных

Описание

Возвращает информацию о конкретной базе данных в Amazon Lightsail.

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

Синтаксис

  get-relational-database
--relational-database-name <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]

Параметры

--relational-database-name (строка)

Имя базы данных, которую вы хотите получить.

--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.

Чтобы получить информацию о реляционной базе данных

Следующий get-relational-database пример отображает детали указанной реляционной базы данных.

aws lightsail get-relational-database \
    --relational-database-name Database-1

Вывод:

{
    "relationalDatabase": {
        "name": "Database-1",
        "arn": "arn:aws:lightsail:us-west-2:111122223333:RelationalDatabase/7ea932b1-b85a-4bd5-9b3e-bEXAMPLE8cc4",
        "supportCode": "6EXAMPLE3362/ls-9EXAMPLE8ad863723b62cc8901a8aa6e794ae0d2",
        "createdAt": 1571259453.795,
        "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": false,
        "pendingModifiedValues": {},
        "engine": "mysql",
        "engineVersion": "8.0.16",
        "masterUsername": "dbmasteruser",
        "parameterApplyStatus": "in-sync",
        "preferredBackupWindow": "10:01-10:31",
        "preferredMaintenanceWindow": "sat:11:14-sat:11:44",
        "publiclyAccessible": true,
        "masterEndpoint": {
            "port": 3306,
            "address": "ls-9EXAMPLE8ad863723b62ccEXAMPLEa6e794ae0d2.czowadgeezqi.us-west-2.rds.amazonaws.com"
        },
        "pendingMaintenanceActions": []
    }
}

Вывод

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

Объект, описывающий указанную базу данных.

name -> (строка)

Уникальное имя ресурса базы данных в Lightsail.

arn -> (строка)

Amazon Resource Name (ARN) базы данных.

supportCode -> (строка)

Код поддержки базы данных. Включите этот код в свое письмо в службу поддержки, если у вас есть вопросы о базе данных в Lightsail. Этот код позволяет нашей команде поддержки легче найти вашу информацию Lightsail.

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

Метка времени создания базы данных. Формат — Unix time.

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

Имя региона и Availability Zone, где расположена база данных.

availabilityZone -> (строка)

Availability Zone. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail для базы данных (например, RelationalDatabase).

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Дополнительную информацию о тегах в Lightsail см. в Руководстве разработчика Amazon Lightsail.

(структура)

Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в Руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

relationalDatabaseBlueprintId -> (строка)

ID шаблона для базы данных. Шаблон описывает основную версию движка базы данных.

relationalDatabaseBundleId -> (строка)

ID пакета для базы данных. Пакет описывает характеристики производительности вашей базы данных.

masterDatabaseName -> (строка)

Имя мастер-базы данных, созданной при создании ресурса базы данных Lightsail.

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

Описание аппаратного обеспечения базы данных.

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

Количество vCPU для базы данных.

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

Размер диска для базы данных.

ramSizeInGb -> (вещественное число)

Объем ОЗУ в ГБ для базы данных.

state -> (строка)

Описание текущего состояния базы данных.

secondaryAvailabilityZone -> (строка)

Описание вторичной Availability Zone базы данных высокой доступности.

Вторичная база данных используется для поддержки переключения в случае отказа базы данных высокой доступности.

backupRetentionEnabled -> (логическое значение)

Булево значение, указывающее, включена ли автоматическая настройка сохранения резервных копий для базы данных.

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

Описание ожидающих изменений значений базы данных.

masterUserPassword -> (строка)

Пароль для пользователя master базы данных.

engineVersion -> (строка)

Версия движка базы данных.

backupRetentionEnabled -> (логическое значение)

Булево значение, указывающее, включена ли автоматическая настройка сохранения резервных копий.

engine -> (строка)

Программное обеспечение базы данных (например, MySQL).

engineVersion -> (строка)

Версия движка базы данных (например, 5.7.23).

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

Последняя точка времени, до которой база данных может быть восстановлена. Формат — Unix time.

masterUsername -> (строка)

Имя пользователя master базы данных.

parameterApplyStatus -> (строка)

Статус обновлений параметров для базы данных.

preferredBackupWindow -> (строка)

Ежедневный диапазон времени, в течение которого создаются автоматические резервные копии базы данных (например, 16:00-16:30).

preferredMaintenanceWindow -> (строка)

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

В формате ddd:hh24:mi-ddd:hh24:mi. Например, Tue:17:00-Tue:17:30.

publiclyAccessible -> (логическое значение)

Булево значение, указывающее, доступна ли база данных для общего доступа.

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

Мастер-точку входа для базы данных.

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

Указывает порт, на котором прослушивается база данных.

address -> (строка)

Указывает DNS-адрес базы данных.

pendingMaintenanceActions -> (список)

Описание ожидающих действий по техническому обслуживанию базы данных.

(структура)

Описание ожидающего действия по техническому обслуживанию базы данных.

action -> (строка)

Тип ожидающего действия по техническому обслуживанию базы данных.

description -> (строка)

Дополнительные сведения об ожидающем действии по техническому обслуживанию базы данных.

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

Дата вступления в силу ожидающего действия по техническому обслуживанию базы данных.

caCertificateIdentifier -> (строка)

Сертификат, связанный с базой данных.

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

Spec-Zone.ru

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