Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

describe-global-clusters

Описание

Возвращает информацию о глобальных базах данных Neptune. Данный API поддерживает пагинацию.

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

describe-global-clusters является операцией с пагинацией. Для получения всего набора результатов могут быть вызваны несколько вызовов API. Вы можете отключить пагинацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: GlobalClusters

Синтаксис

  describe-global-clusters
[--global-cluster-identifier <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]

Параметры

--global-cluster-identifier (строка)

Указанный пользователем идентификатор кластера БД. Если этот параметр указан, возвращается только информация о заданном кластере БД. Этот параметр нечувствителен к регистру.

Ограничения: если указан, должен соответствовать существующему идентификатору кластера БД.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет взята буквально. Это нельзя указать вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания, с чего начать пагинацию. Это NextToken из предыдущего усеченного ответа.

Примеры использования см. в разделе «Пагинация» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе «Пагинация» в Руководстве пользователя 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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

Marker -> (строка)

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

GlobalClusters -> (список)

Список глобальных кластеров и экземпляров, возвращенных в этом запросе.

(структура)

Содержит сведения о глобальной базе данных Amazon Neptune.

Этот тип данных используется в качестве элемента ответа для действий CreateGlobalCluster , DescribeGlobalClusters , ModifyGlobalCluster , DeleteGlobalCluster , FailoverGlobalCluster и RemoveFromGlobalCluster.

GlobalClusterIdentifier -> (строка)

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

GlobalClusterResourceId -> (строка)

Неизменяемый идентификатор глобальной базы данных, уникальный во всех регионах. Этот идентификатор можно найти в журнале CloudTrail всякий раз, когда обращаются к ключу KMS для кластера БД.

GlobalClusterArn -> (строка)

Amazon Resource Name (ARN) для глобальной базы данных.

Status -> (строка)

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

Engine -> (строка)

Двигатель базы данных Neptune, используемый глобальной базой данных ("neptune").

EngineVersion -> (строка)

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

StorageEncrypted -> (булево)

Параметр шифрования хранилища для глобальной базы данных.

DeletionProtection -> (булево)

Параметр защиты от удаления для глобальной базы данных.

GlobalClusterMembers -> (список)

Список ARN кластеров и ARN экземпляров для всех кластеров БД, которые являются частью глобальной базы данных.

(структура)

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

DBClusterArn -> (строка)

Amazon Resource Name (ARN) для каждого кластера Neptune.

Readers -> (список)

Amazon Resource Name (ARN) для каждого вторичного кластера чтения/только для чтения, связанного с глобальной базой данных Neptune.

(строка)

IsWriter -> (булево)

Указывает, является ли кластер Neptune первичным кластером (т. е. имеет возможности чтения/записи) для глобальной базы данных Neptune, с которой он связан.

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

Объект данных, содержащий все свойства для текущего состояния процесса переключения или аварийного переключения, выполняемого или ожидаемого для этого глобального кластера (глобальной базы данных Neptune). Этот объект пуст, если для этого глобального кластера не был вызван оператор SwitchoverGlobalCluster или FailoverGlobalCluster.

Status -> (строка)

Текущий статус глобального кластера. Возможные значения следующие:

  • pending – Сервис получил запрос на переключение или аварийное переключение глобального кластера. Первичный кластер БД глобального кластера и указанный вторичный кластер БД проверяются перед началом операции.
  • failing-over – Neptune продвигает выбранный вторичный кластер Neptune DB до нового первичного кластера DB для аварийного переключения глобального кластера.
  • cancelling – Запрос на переключение или аварийное переключение глобального кластера был отменен, и первичный кластер БД Neptune и выбранный вторичный кластер Neptune DB возвращаются к их предыдущим состояниям.
  • switching-over – Этот статус охватывает диапазон внутренних операций Neptune, которые происходят во время процесса переключения, например, понижение первичного кластера БД Neptune, повышение вторичного кластера БД Neptune и синхронизация реплик.

FromDbClusterArn -> (строка)

Amazon Resource Name (ARN) кластера БД Neptune, который в настоящее время понижается и связан с этим состоянием.

ToDbClusterArn -> (строка)

Amazon Resource Name (ARN) кластера БД Neptune, который в настоящее время повышается и связан с этим состоянием.

IsDataLossAllowed -> (булево)

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

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

Spec-Zone.ru

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