Spec-Zone.ru › AWS CLI v2

[ aws . finspace ]

get-kx-environment

Описание

Получает всю информацию для указанной среды kdb.

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

Синтаксис

  get-kx-environment
--environment-id <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]

Параметры

--environment-id (строка)

Уникальный идентификатор среды kdb.

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

Вывод

name -> (строка)

Имя среды kdb.

environmentId -> (строка)

Уникальный идентификатор среды kdb.

awsAccountId -> (строка)

Уникальный идентификатор AWS-аккаунта, который используется для создания среды kdb.

status -> (строка)

Статус среды kdb.

tgwStatus -> (строка)

Статус конфигурации сети.

dnsStatus -> (строка)

Статус конфигурации DNS.

errorMessage -> (строка)

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

description -> (строка)

Описание среды kdb.

environmentArn -> (строка)

Идентификатор ARN среды.

kmsKeyId -> (строка)

Идентификатор ключа KMS для шифрования данных в среде FinSpace.

dedicatedServiceAccountId -> (строка)

Уникальный идентификатор AWS-аккаунта инфраструктуры среды.

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

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

transitGatewayID -> (строка)

Идентификатор транзитной шлюзовой, созданной клиентом для подключения исходящего трафика из сети kdb к вашей внутренней сети.

routableCIDRSpace -> (строка)

CIDR маршрутизации от имени среды kdb. Может быть любым диапазоном «/26» в пространстве CIDR 100.64.0.0. После предоставления он будет добавлен в таблицу маршрутизации транзитной шлюзовой клиента, чтобы трафик мог маршрутизироваться в сеть kdb.

attachmentNetworkAclConfiguration -> (список)

Правила, определяющие, как управлять исходящим трафиком из сети kdb в вашу внутреннюю сеть.

(структура)

Список управления доступом к сети (ACL) — это необязательный уровень безопасности для вашей VPC, который действует как брандмауэр для управления трафиком в и из одного или нескольких подсетей. Элемент — это набор пронумерованных правил входящего и исходящего трафика, определяющих, разрешать ли пакет в или из подсети, связанной с ACL. Мы обрабатываем элементы ACL в соответствии с номерами правил в порядке возрастания.

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

Номер правила для элемента. Например, 100. Все элементы списка управления доступом к сети обрабатываются в порядке возрастания номера правила.

protocol -> (строка)

Номер протокола. Значение -1 означает все протоколы.

ruleAction -> (строка)

Указывает, разрешать или запрещать трафик, соответствующий правилу.

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

Диапазон портов, к которым применяется правило.

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

Первый порт в диапазоне.

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

Последний порт в диапазоне.

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

Определяет протокол ICMP, состоящий из типа и кода ICMP.

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

Тип ICMP. Значение -1 означает все типы.

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

Код ICMP. Значение -1 означает все коды для указанного типа ICMP.

cidrBlock -> (строка)

Диапазон IPv4-сети для разрешения или запрета в формате CIDR. Например, 172.16.0.0/24. Мы модифицируем указанный блок CIDR до его канонической формы. Например, если вы указали 100.68.0.18/18, мы модифицируем его до 100.68.0.0/18.

customDNSConfiguration -> (список)

Список имен и IP-адресов DNS-серверов. Используется для настройки исходящих разрешителей Route-53.

(структура)

Список имен и IP-адресов DNS-серверов. Используется для настройки исходящих разрешителей Route-53.

customDNSServerName -> (строка)

Имя DNS-сервера.

customDNSServerIP -> (строка)

IP-адрес DNS-сервера.

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

Метка времени создания среды kdb в FinSpace.

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

Метка времени обновления среды kdb.

availabilityZoneIds -> (список)

Идентификатор зон доступности, где создаются подсети для среды.

(строка)

certificateAuthorityArn -> (строка)

Amazon Resource Name (ARN) центра сертификации среды kdb.

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

Spec-Zone.ru

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