Spec-Zone.ru › AWS CLI v2

[ aws . memorydb ]

failover-shard

Описание

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

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

Синтаксис

  failover-shard
--cluster-name <value>
--shard-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]

Параметры

--cluster-name (строка)

Кластер, который переключается на резервный.

--shard-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 для вывода.

--cli-auto-prompt (логическое значение)

Автоматическое запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключение автоматического запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Для переключения резервного шара

Следующий пример failover-shard` переключает резервный шар.

aws memorydb failover-shard \
    --cluster-name my-cluster --shard-name 0001

Вывод:

{
    "Cluster": {
        "Name": "my-cluster",
        "Status": "available",
        "NumberOfShards": 2,
        "ClusterEndpoint": {
            "Address": "clustercfg.my-cluster.xxxxxx.memorydb.us-east-1.amazonaws.com",
            "Port": 6379
        },
        "NodeType": "db.r6g.large",
        "EngineVersion": "6.2",
        "EnginePatchVersion": "6.2.6",
        "ParameterGroupName": "default.memorydb-redis6",
        "ParameterGroupStatus": "in-sync",
        "SecurityGroups": [
            {
                "SecurityGroupId": "sg-0a143xxxx45c9fae",
                "Status": "active"
            }
        ],
        "SubnetGroupName": "my-sg",
        "TLSEnabled": true,
        "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster",
        "SnapshotRetentionLimit": 0,
        "MaintenanceWindow": "wed:03:00-wed:04:00",
        "SnapshotWindow": "04:30-05:30",
        "AutoMinorVersionUpgrade": true
    }
}

Дополнительную информацию см. в разделе Минимизация простоев с помощью MultiAZ в руководстве пользователя MemoryDB.

Вывод

Кластер -> (структура)

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

Имя -> (строка)

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

Описание -> (строка)

Описание кластера

Состояние -> (строка)

Состояние кластера. Например, Доступен, Обновляется, Создается.

Ожидаемые обновления -> (структура)

Группа настроек, которые в настоящее время применяются.

Перераспределение -> (структура)

Состояние операции онлайн-перераспределения.

Миграция слотов -> (структура)

Состояние онлайн-миграции слотов перераспределения

Процент выполнения -> (двойное)

Процент завершенной миграции слотов.

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

Список ACL, связанных с кластером, которые обновляются

Применяемый ACL -> (строка)

Список ACL, которые ожидают применения.

Обновления служб -> (список)

Список обновлений служб, применяемых к кластеру

(структура)

Действие обновления, которое еще не обработано для соответствующего запроса применения/остановки

Имя обновления службы -> (строка)

Уникальный идентификатор обновления службы

Состояние -> (строка)

Состояние обновления службы

Имя многорегионального кластера -> (строка)

Имя многорегионального кластера, к которому принадлежит этот кластер.

Количество фрагментов -> (целое)

Количество фрагментов в кластере

Фрагменты -> (список)

Список фрагментов, которые являются членами кластера.

(структура)

Представляет собой набор узлов в кластере. Один узел в группе узлов является основным узлом чтения/записи. Все остальные узлы — это узлы реплики только для чтения.

Имя -> (строка)

Имя фрагмента

Состояние -> (строка)

Текущее состояние этой группы репликации — создание, доступно, изменение, удаление.

Слоты -> (строка)

Пространство имен для этого фрагмента.

Узлы -> (список)

Список, содержащий информацию об отдельных узлах внутри фрагмента

(структура)

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

Имя -> (строка)

Идентификатор узла. Имя узла — это числовой идентификатор (0001, 0002 и т. д.). Сочетание имени кластера, имени фрагмента и имени узла однозначно идентифицирует каждый узел, используемый в учетной записи Amazon клиента.

Состояние -> (строка)

Состояние обновления службы на узле

Зона доступности -> (строка)

Зона доступности, в которой находится узел

Время создания -> (временная метка)

Дата и время создания узла.

Конечная точка -> (структура)

Имя хоста для подключения к этому узлу.

Адрес -> (строка)

Имя хоста DNS узла.

Порт -> (целое)

Номер порта, на котором работает движок.

Количество узлов -> (целое)

Количество узлов в фрагменте

Режим доступности -> (строка)

Указывает, имеет ли кластер конфигурацию Multi-AZ (multiaz) или нет (singleaz).

Конечная точка кластера -> (структура)

Конечная точка конфигурации кластера

Адрес -> (строка)

Имя хоста DNS узла.

Порт -> (целое)

Номер порта, на котором работает движок.

Тип узла -> (строка)

Тип узла кластера

Движок -> (строка)

Имя движка, используемого кластером.

Версия движка -> (строка)

Версия движка Redis OSS, используемая кластером

Версия исправления движка -> (строка)

Версия исправления движка Redis OSS, используемая кластером

Имя группы параметров -> (строка)

Имя группы параметров, используемой кластером

Состояние группы параметров -> (строка)

Состояние группы параметров, используемой кластером, например, «активно» или «применяется».

Группы безопасности -> (список)

Список групп безопасности, используемых кластером

(структура)

Представляет собой отдельную группу безопасности и ее состояние.

Идентификатор группы безопасности -> (строка)

Идентификатор группы безопасности.

Состояние -> (строка)

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

Имя группы подсетей -> (строка)

Имя группы подсетей, используемой кластером

TLSEnabled -> (булево)

Флаг, указывающий, включено ли шифрование в процессе передачи

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемого для шифрования кластера

ARN -> (строка)

Amazon Resource Name (ARN) кластера.

SnsTopicArn -> (строка)

Amazon Resource Name (ARN) темы уведомлений SNS

Состояние темы SNS -> (строка)

Тема SNS должна находиться в активном состоянии, чтобы получать уведомления

Предел удержания снимков -> (целое)

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

Окно технического обслуживания -> (строка)

Указывает еженедельный временной интервал, в течение которого выполняется техническое обслуживание кластера. Он задается как диапазон в формате ddd:hh24:mi-ddd:hh24:mi (24-часовой формат времени UTC). Минимальное окно технического обслуживания — 60 минут.

Окно снимка -> (строка)

Ежедневный временной интервал (в формате UTC), в течение которого MemoryDB начинает создание ежедневного снимка вашего фрагмента. Пример: 05:00-09:00 Если вы не укажете этот параметр, MemoryDB автоматически выберет соответствующий временной интервал.

Имя ACL -> (строка)

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

Автоматическое обновление незначительных версий -> (булево)

При установке в значение true кластер будет автоматически получать незначительные обновления версии движка после запуска.

Иерархия данных -> (строка)

Включает иерархию данных. Иерархия данных поддерживается только для кластеров, использующих тип узла r6gd. Этот параметр должен быть задан при использовании узлов r6gd. Дополнительную информацию см. в разделе Иерархия данных.

Тип сети -> (строка)

Тип IP-адреса для кластера. Возвращает «ipv4» для только IPv4, «ipv6» для только IPv6 или «dual-stack», если кластер поддерживает как IPv4, так и IPv6 адресацию.

Обнаружение IP-адресов -> (строка)

Механизм, который кластер использует для обнаружения IP-адресов. Возвращает «ipv4», когда DNS-конечные точки разрешаются до IPv4-адресов, или «ipv6», когда DNS-конечные точки разрешаются до IPv6-адресов.

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

Spec-Zone.ru

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