Spec-Zone.ru › AWS CLI v2

[ aws . neptunedata ]

get-engine-status

Описание

Получает состояние графовой базы данных на хосте.

При вызове этой операции в кластере Neptune, в котором включена аутентификация IAM, пользователь или роль IAM, производящая запрос, должны иметь прикреплённую политику, разрешающую действие neptune-db:GetEngineStatus в этом кластере.

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

get-engine-status использует значения типа документа. Типы документов следуют модели JSON-данных, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  get-engine-status
[--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]

Параметры

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

status -> (строка)

Устанавливается в healthy, если экземпляр не испытывает проблем. Если экземпляр восстанавливается после сбоя или перезагрузки и есть активные транзакции, выполняющиеся с момента последнего завершения работы сервера, status устанавливается в recovery.

startTime -> (строка)

Устанавливается в UTC-время запуска текущего процесса сервера.

dbEngineVersion -> (строка)

Устанавливается в версию движка Neptune, работающего в вашем кластере БД. Если эта версия движка была вручную исправлена после выпуска, номер версии предваряется Patch-.

role -> (строка)

Устанавливается в reader, если экземпляр является чтением-репликой, или в writer, если экземпляр является главным экземпляром.

dfeQueryEngine -> (строка)

Устанавливается в enabled, если движок DFE полностью включен, или в viaQueryHint (по умолчанию), если движок DFE используется только с запросами, у которых подсказка запроса useDFE установлена в true.

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

Содержит информацию о языке запросов Gremlin, доступном в вашем кластере. В частности, он содержит поле version, которое указывает текущую версию TinkerPop, используемую движком.

version -> (строка)

Версия языка запросов.

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

Содержит информацию о языке запросов SPARQL, доступном в вашем кластере. В частности, он содержит поле version, которое указывает текущую версию SPARQL, используемую движком.

version -> (строка)

Версия языка запросов.

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

Содержит информацию о языке запросов openCypher, доступном в вашем кластере. В частности, он содержит поле version, которое указывает текущую версию openCypher, используемую движком.

version -> (строка)

Версия языка запросов.

labMode -> (карта)

Содержит настройки режима Lab, используемые движком.

key -> (строка)

value -> (строка)

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

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

rollingBackTrxEarliestStartTime -> (строка)

Устанавливается в время начала самой ранней транзакции, откат которой выполняется. Если откат транзакций не выполняется, поле вообще не отображается.

features -> (карта)

Содержит информацию о статусе функций, включённых в вашем кластере БД.

key -> (строка)

value -> (документ)

settings -> (карта)

Содержит информацию о текущих настройках вашего кластера БД. Например, содержит текущую настройку тайм-аута запросов кластера (clusterQueryTimeoutInMs).

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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