Spec-Zone.ru › AWS CLI v2

[ aws . timestream-influxdb ]

get-db-instance

Описание

Возвращает экземпляр базы данных Timestream for InfluxDB.

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

Синтаксис

  get-db-instance
--identifier <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]

Параметры

--identifier (строка)

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

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

Вывод

id -> (строка)

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

name -> (строка)

Указанное пользователем имя, которое однозначно идентифицирует экземпляр базы данных при взаимодействии с API Amazon Timestream for InfluxDB и командами CLI.

arn -> (строка)

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

status -> (строка)

Статус экземпляра базы данных.

endpoint -> (строка)

Адрес, используемый для подключения к InfluxDB. По умолчанию порт InfluxDB составляет 8086.

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

Номер порта, на котором InfluxDB принимает подключения.

networkType -> (строка)

Указывает, является ли networkType экземпляра Timestream for InfluxDB IPV4, который может обмениваться данными только по протоколу IPv4, или DUAL, который может обмениваться данными по протоколам IPv4 и IPv6.

dbInstanceType -> (строка)

Тип экземпляра Timestream for InfluxDB, на котором работает InfluxDB.

dbStorageType -> (строка)

Тип хранения данных базы данных Timestream for InfluxDB, в котором InfluxDB хранит данные.

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

Объем выделенного хранилища для вашего типа хранилища базы данных (в гибибайтах).

deploymentType -> (строка)

Указывает, развернут ли Timestream for InfluxDB как Single-AZ или с MultiAZ Standby для высокой доступности.

vpcSubnetIds -> (список)

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

(строка)

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

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

vpcSecurityGroupIds -> (список)

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

(строка)

dbParameterGroupIdentifier -> (строка)

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

availabilityZone -> (строка)

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

secondaryAvailabilityZone -> (строка)

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

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

Настройка для отправки журналов движка InfluxDB в указанный ведро S3.

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

Настройка доставки журналов в ведро S3.

bucketName -> (строка)

Имя ведра S3 для доставки журналов.

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

Указывает, включена ли доставка журналов в ведро S3.

influxAuthParametersSecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего начальные параметры авторизации InfluxDB. Значение секрета представляет собой JSON-форматированную пару ключ-значение, содержащую значения авторизации InfluxDB: организация, ведро, имя пользователя и пароль.

dbClusterId -> (строка)

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

instanceMode -> (строка)

Указывает роль DbInstance в кластере.

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

Spec-Zone.ru

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