Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

reboot-db-instance

Описание

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

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

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

Синтаксис

  reboot-db-instance
--db-instance-identifier <value>
[--force-failover | --no-force-failover]
[--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]

Параметры

--db-instance-identifier (строка)

Идентификатор экземпляра. Этот параметр хранится как строка в нижнем регистре.

Ограничения:

  • Должен соответствовать идентификатору существующего DBInstance.

--force-failover | --no-force-failover (логическое значение)

При true перезагрузка выполняется через аварийное переключение Multi-AZ.

Ограничение: Вы не можете указать true, если экземпляр не настроен для Multi-AZ.

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

Следующий reboot-db-instance пример перезапускает экземпляр Amazon DocumentDB sample-cluster2.

aws docdb reboot-db-instance \
    --db-instance-identifier sample-cluster2

Эта команда не выводит никаких данных. Вывод:

{
    "DBInstance": {
        "PreferredBackupWindow": "18:00-18:30",
        "DBInstanceIdentifier": "sample-cluster2",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "DBSubnetGroup": {
            "VpcId": "vpc-91280df6",
            "Subnets": [
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "SubnetGroupStatus": "Complete",
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default"
        },
        "PendingModifiedValues": {},
        "Endpoint": {
            "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "HostedZoneId": "ZNKXH85TT8WVW",
            "Port": 27017
        },
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "StorageEncrypted": false,
        "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA",
        "AutoMinorVersionUpgrade": true,
        "Engine": "docdb",
        "InstanceCreateTime": "2019-03-15T20:36:06.338Z",
        "EngineVersion": "3.6.0",
        "PromotionTier": 5,
        "BackupRetentionPeriod": 7,
        "DBClusterIdentifier": "sample-cluster",
        "PreferredMaintenanceWindow": "mon:08:39-mon:09:09",
        "PubliclyAccessible": false,
        "DBInstanceClass": "db.r4.4xlarge",
        "AvailabilityZone": "us-west-2d",
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
        "DBInstanceStatus": "rebooting"
    }
}

Дополнительную информацию см. в разделе Перезагрузка экземпляра Amazon DocumentDB ILnstance в руководстве разработчика Amazon DocumentDB.

Вывод

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

Подробная информация об экземпляре.

DBInstanceIdentifier -> (строка)

Содержит предоставленный пользователем идентификатор базы данных. Этот идентификатор является уникальным ключом, определяющим экземпляр.

DBInstanceClass -> (строка)

Содержит название класса вычислительной и оперативной мощности экземпляра.

Engine -> (строка)

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

DBInstanceStatus -> (строка)

Указывает текущее состояние этой базы данных.

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

Указывает конечную точку подключения.

Address -> (строка)

Указывает DNS-адрес экземпляра.

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

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

HostedZoneId -> (строка)

Указывает ID, который Amazon Route 53 присваивает при создании хостированной зоны.

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

Предоставляет дату и время создания экземпляра.

PreferredBackupWindow -> (строка)

Указывает диапазон времени в течение суток, в котором создаются автоматические резервные копии, если автоматические резервные копии включены, как определено BackupRetentionPeriod.

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

Указывает количество дней, в течение которых сохраняются автоматические снимки.

VpcSecurityGroups -> (список)

Предоставляет список элементов группы безопасности VPC, к которой принадлежит экземпляр.

(структура)

Используется как элемент ответа для запросов о членстве в группе безопасности виртуальной частной сети (VPC).

VpcSecurityGroupId -> (строка)

Название группы безопасности VPC.

Status -> (строка)

Статус группы безопасности VPC.

AvailabilityZone -> (строка)

Указывает название зоны доступности, в которой расположен экземпляр.

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

Указывает информацию о группе подсетей, связанной с экземпляром, включая имя, описание и подсети в группе подсетей.

DBSubnetGroupName -> (строка)

Имя группы подсетей.

DBSubnetGroupDescription -> (строка)

Предоставляет описание группы подсетей.

VpcId -> (строка)

Предоставляет идентификатор виртуальной частной сети (VPC) группы подсетей.

SubnetGroupStatus -> (строка)

Предоставляет статус группы подсетей.

Subnets -> (список)

Подробная информация об одной или нескольких подсетях в группе подсетей.

(структура)

Подробная информация о подсети.

SubnetIdentifier -> (строка)

Указывает идентификатор подсети.

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

Указывает зону доступности для подсети.

Name -> (строка)

Название зоны доступности.

SubnetStatus -> (строка)

Указывает статус подсети.

DBSubnetGroupArn -> (строка)

Amazon Resource Name (ARN) для группы подсетей DB.

PreferredMaintenanceWindow -> (строка)

Указывает еженедельный временной диапазон, в течение которого может происходить техническое обслуживание системы в формате Coordinated Universal Time (UTC).

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

Указывает, что изменения в экземпляре находятся в ожидании. Этот элемент включается только в том случае, если изменения ожидаются. Конкретные изменения определяются подэлементами.

DBInstanceClass -> (строка)

Содержит новый DBInstanceClass для экземпляра, который будет применен или в настоящее время применяется.

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

Содержит новый размер AllocatedStorage для экземпляра, который будет применен или в настоящее время применяется.

MasterUserPassword -> (строка)

Содержит ожидаемое или в настоящее время выполняемое изменение учетных данных администратора для экземпляра.

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

Указывает ожидаемый порт для экземпляра.

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

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

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

Указывает, что экземпляр Single-AZ должен перейти к развертыванию Multi-AZ.

EngineVersion -> (строка)

Указывает версию движка базы данных.

LicenseModel -> (строка)

Модель лицензии для экземпляра.

Допустимые значения: license-included , bring-your-own-license , general-public-license

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

Указывает новое значение Provisioned IOPS для экземпляра, которое будет применено или в настоящее время применяется.

DBInstanceIdentifier -> (строка)

Содержит новый DBInstanceIdentifier для экземпляра, который будет применен или в настоящее время применяется.

StorageType -> (строка)

Указывает тип хранилища, который должен быть связан с экземпляром.

CACertificateIdentifier -> (строка)

Указывает идентификатор сертификата центра сертификации (CA) для экземпляра базы данных.

DBSubnetGroupName -> (строка)

Новая группа подсетей для экземпляра.

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

Список типов журналов, конфигурация которых все еще находится в ожидании. Эти типы журналов находятся в процессе активации или деактивации.

LogTypesToEnable -> (список)

Типы журналов, которые находятся в процессе деактивации. После их деактивации эти типы журналов не экспортируются в CloudWatch Logs.

(строка)

LogTypesToDisable -> (список)

Типы журналов, которые находятся в процессе активации. После их активации эти типы журналов экспортируются в Amazon CloudWatch Logs.

(строка)

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

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

EngineVersion -> (строка)

Указывает версию движка базы данных.

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

Не применимо. Этот параметр не применим к Amazon DocumentDB. Amazon DocumentDB не выполняет обновления до младших версий независимо от установленного значения.

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

Не поддерживается. Amazon DocumentDB в настоящее время не поддерживает общедоступные конечные точки. Значение PubliclyAccessible всегда равно false.

StatusInfos -> (список)

Статус реплики чтения. Если экземпляр не является репликой чтения, это пусто.

(структура)

Предоставляет список информации о статусе экземпляра.

StatusType -> (строка)

Это значение в настоящее время «read replication».

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

Логическое значение, которое равно true, если экземпляр работает нормально, или false, если экземпляр находится в состоянии ошибки.

Status -> (строка)

Статус экземпляра. Для реплики чтения значения могут быть replicating, ошибка, stopped или terminated.

Message -> (строка)

Подробности ошибки, если для экземпляра имеется ошибка. Если экземпляр не находится в состоянии ошибки, это значение пусто.

DBClusterIdentifier -> (строка)

Содержит имя кластера, к которому принадлежит экземпляр, если экземпляр является членом кластера.

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

Указывает, зашифрован ли экземпляр.

KmsKeyId -> (строка)

Если StorageEncrypted равно true, идентификатор ключа KMS для зашифрованного экземпляра.

DbiResourceId -> (строка)

Уникальный, неизменяемый идентификатор экземпляра, уникальный для региона Amazon Web Services. Этот идентификатор можно найти в записях журналов CloudTrail всякий раз, когда к ключу KMS для экземпляра осуществляется доступ.

CACertificateIdentifier -> (строка)

Идентификатор сертификата CA для этого экземпляра базы данных.

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

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

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

Значение, определяющее порядок, в котором реплика Amazon DocumentDB повышается до основного экземпляра после сбоя основного экземпляра.

DBInstanceArn -> (строка)

Amazon Resource Name (ARN) для экземпляра.

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, которые этот экземпляр настроен на экспорт в CloudWatch Logs.

(строка)

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

Подробности серверного сертификата экземпляра базы данных.

CAIdentifier -> (строка)

Идентификатор CA используемого сертификата CA для серверного сертификата экземпляра базы данных.

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

Дата истечения срока действия серверного сертификата экземпляра базы данных.

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

Устанавливается в true, если для экземпляра базы данных включена Amazon RDS Performance Insights, и в противном случае в false.

PerformanceInsightsKMSKeyId -> (строка)

Идентификатор ключа KMS для шифрования данных Performance Insights. Идентификатор ключа KMS — это Amazon Resource Name (ARN), идентификатор ключа KMS или псевдоним ключа KMS для ключа шифрования KMS.

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

Spec-Zone.ru

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