Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

describe-domains

Описание

Возвращает информацию о конфигурации указанных доменов Amazon OpenSearch Service.

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

Синтаксис

  describe-domains
--domain-names <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]

Параметры

--domain-names (список)

Массив имён доменов OpenSearch Service, для которых требуется информация. Необходимо указать хотя бы одно имя домена.

(строка)

Имя домена OpenSearch Service. Имена доменов уникальны для всех доменов, принадлежащих учётной записи в регионе Amazon Web Services.

Синтаксис:

"string" "string" ...

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

Вывод

DomainStatusList -> (список)

Статус запрошенных доменов.

(структура)

Текущий статус домена службы OpenSearch.

DomainId -> (строка)

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

DomainName -> (строка)

Имя домена. Имена доменов уникальны для всех доменов, принадлежащих одному аккаунту в регионе Amazon Web Services.

ARN -> (строка)

Amazon Resource Name (ARN) домена. Дополнительная информация представлена в руководстве по IAM в разделе AWS Identity and Access Management User Guide.

Created -> (булево)

Статус создания домена службы OpenSearch. True, если создание домена завершено. False, если создание домена всё ещё в процессе.

Deleted -> (булево)

Статус удаления домена службы OpenSearch. True, если удаление домена завершено. False, если удаление домена всё ещё в процессе. После завершения удаления статус домена больше не возвращается.

Endpoint -> (строка)

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

EndpointV2 -> (строка)

Если IPAddressType, то будет предоставлен конечный пункт домена версии 2. Этот конечный пункт работает как обычный конечный пункт, за исключением того, что он работает с IP-адресами IPv4 и IPv6. Обычные конечные пункты работают только с IP-адресами IPv4.

Endpoints -> (карта)

Пара ключ-значение, которая существует, если домен службы OpenSearch использует VPC-конечные пункты. Например:

  • IPv4 IP-адреса - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
  • IP-адреса двойной стековой адресации - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

ключ -> (строка)

значение -> (строка)

Конечный пункт домена, куда направляются запросы на индексацию и поиск. Например, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com или doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

DomainEndpointV2HostedZoneId -> (строка)

Идентификатор узла размещения двойной стековой адресации для домена.

Processing -> (булево)

Статус конфигурации домена. True, если служба OpenSearch обрабатывает изменения конфигурации. False, если конфигурация активна.

UpgradeProcessing -> (булево)

Статус обновления домена до новой версии OpenSearch или Elasticsearch. True, если служба OpenSearch находится в процессе обновления версии. False, если конфигурация активна.

EngineVersion -> (строка)

Версия OpenSearch или Elasticsearch, на которой работает домен, в формате Elasticsearch_X.Y или OpenSearch_X.Y.

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

Контейнер для конфигурации кластера домена.

InstanceType -> (строка)

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

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

Количество узлов данных в кластере. Это число должно быть больше 1, в противном случае возникает исключение проверки.

DedicatedMasterEnabled -> (булево)

Указывает, включены ли выделенные мастер-узлы для кластера. «True», если кластер будет использовать выделенный мастер-узел. «False», если кластер не будет.

ZoneAwarenessEnabled -> (булево)

Указывает, включены ли несколько зон доступности. Дополнительная информация в документе Configuring a multi-AZ domain in Amazon OpenSearch Service.

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

Контейнер для параметров конфигурации осознания зоны. Требуется только если ZoneAwarenessEnabled равно true.

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

Если вы включили несколько зон доступности, это значение представляет количество зон, которые вы хотите использовать для домена. Допустимые значения — 2 и 3. Если ваш домен развернут в VPC, это значение будет равно числу подсетей.

DedicatedMasterType -> (строка)

Тип экземпляра службы OpenSearch выделенных мастер-узлов в кластере.

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

Количество выделенных мастер-узлов в кластере. Это число должно быть больше 2 и не равно 4, в противном случае возникает исключение валидации.

WarmEnabled -> (булево)

Включить или отключить тёплую хранилище для кластера.

WarmType -> (строка)

Тип экземпляра для тёплых узлов кластера.

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

Количество тёплых узлов в кластере.

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

Контейнер для параметров конфигурации холодного хранилища.

Enabled -> (булево)

Включить или отключить холодное хранилище в домене. Для включения холодного хранилища необходимо включить UltraWarm хранилище.

MultiAZWithStandbyEnabled -> (булево)

Булево значение, которое указывает, включён ли многозонный домен со стояночной зоной. Дополнительная информация в документе Configuring a multi-AZ domain in Amazon OpenSearch Service.

NodeOptions -> (список)

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

(структура)

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

NodeType -> (строка)

Определяет тип узла, например, узлы координации.

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

Параметры конфигурации для определения настроек любого типа узла.

Enabled -> (булево)

Булевое значение, указывающее, активен или неактивен конкретный тип узла.

Type -> (строка)

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

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

Количество узлов определённого типа в кластере.

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

Контейнер для параметров хранения на основе EBS для домена.

EBSEnabled -> (булево)

Указывает, подключены ли EBS-тома к узлам данных в домене OpenSearch Service.

VolumeType -> (строка)

Указывает тип EBS-томов, подключенных к узлам данных.

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

Указывает размер (в GiB) EBS-томов, подключенных к узлам данных.

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

Указывает базовую производительность ввода/вывода (I/O) EBS-томов, подключенных к узлам данных. Применимо только для типов EBS-томов gp3 и предоставленных IOPS.

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

Указывает пропускную способность (в MiB/с) EBS-томов, подключенных к узлам данных. Применимо только для типа тома gp3.

AccessPolicies -> (строка)

Документ политики управления доступом (IAM), определяющий политики доступа к домену.

IPAddressType -> (строка)

Тип IP-адресов, поддерживаемых конечным пунктом для домена.

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

УСТАРЕЛО. Контейнер для параметров, необходимых для настройки автоматических снимков индексов домена.

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

Время в формате UTC, когда служба OpenSearch делает ежедневный автоматический снимок указанного домена. По умолчанию — 0 часов.

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

Конфигурация VPC для домена.

VPCId -> (строка)

Идентификатор вашей VPC. Amazon VPC генерирует это значение при создании VPC.

SubnetIds -> (список)

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

(строка)

AvailabilityZones -> (список)

Список зон доступности, связанных с подсетями VPC.

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

Ключ-значение для настройки аутентификации Amazon Cognito для OpenSearch Dashboards.

Enabled -> (булево)

Включить или отключить аутентификацию Amazon Cognito для OpenSearch Dashboards.

UserPoolId -> (строка)

Идентификатор пула пользователей Amazon Cognito, который вы хотите использовать для аутентификации OpenSearch Dashboards.

IdentityPoolId -> (строка)

Идентификатор пула идентификаторов Amazon Cognito, который вы хотите использовать для аутентификации OpenSearch Dashboards.

RoleArn -> (строка)

Роль AmazonOpenSearchServiceCognitoAccess, которая позволяет службе OpenSearch настроить ваш пул пользователей и пул идентификаторов.

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

Настройки шифрования в состоянии покоя для домена.

Enabled -> (булево)

True для включения шифрования в состоянии покоя.

KmsKeyId -> (строка)

Идентификатор ключа KMS. Формат 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

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

Включено или выключено шифрование между узлами.

Enabled -> (булево)

True для включения шифрования между узлами.

AdvancedOptions -> (карта)

Ключ-значение для дополнительных параметров конфигурации.

ключ -> (строка)

значение -> (строка)

LogPublishingOptions -> (карта)

Параметры публикации журналов для домена.

ключ -> (строка)

Тип файла журнала. Может быть одним из следующих:

  • INDEX_SLOW_LOGS - Журналы медленных индексов содержат запросы вставки, которые потребовали больше времени, чем заданный порог журнала запросов индекса, для выполнения.
  • SEARCH_SLOW_LOGS - Журналы медленных поисков содержат поисковые запросы, которые потребовали больше времени, чем заданный порог журнала запросов поиска, для выполнения.
  • ES_APPLICATION_LOGS - Журналы приложений OpenSearch содержат информацию об ошибках и предупреждениях, возникающих во время работы службы, и могут быть полезны для устранения неполадок.
  • AUDIT_LOGS - Журналы аудита содержат записи о запросах пользователей для доступа к домену.

значение -> (структура)

Указывает, публикует ли Amazon OpenSearch Service журналы приложений OpenSearch и медленных запросов в Amazon CloudWatch. Дополнительная информация в документе Monitoring OpenSearch logs with Amazon CloudWatch Logs.

Примечание

После включения публикации журналов вам всё ещё необходимо включить сбор медленных журналов с помощью API OpenSearch REST.

CloudWatchLogsLogGroupArn -> (строка)

Amazon Resource Name (ARN) группы журналов CloudWatch Logs, в которую публикуются журналы.

Enabled -> (булево)

Публиковать ли журнал.

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

Текущий статус программного обеспечения службы домена.

CurrentVersion -> (строка)

Текущая версия программного обеспечения службы, установленная на домене.

NewVersion -> (строка)

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

UpdateAvailable -> (булево)

Истина, если можно обновить версию программного обеспечения службы. Ложь, если обновление невозможно.

Cancellable -> (булево)

Истина, если можно отменить обновление версии программного обеспечения службы. Ложь, если отмена обновления невозможна.

UpdateStatus -> (строка)

Статус обновления программного обеспечения службы.

Description -> (строка)

Описание статуса обновления программного обеспечения службы.

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

Отметка времени (в формате эпохи), до которой можно вручную запросить обновление программного обеспечения службы. После этой даты обновление программного обеспечения происходит автоматически.

OptionalDeployment -> (булево)

Истина, если программное обеспечение службы никогда не обновляется автоматически. Ложь, если программное обеспечение службы обновляется автоматически после даты автоматического обновления.

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

Дополнительные параметры для конечной точки домена, такие как требование HTTPS для всего трафика.

EnforceHTTPS -> (булево)

Истина, если требуется, чтобы весь трафик домена поступал по протоколу HTTPS.

TLSSecurityPolicy -> (строка)

Укажите политику безопасности TLS для применения к конечной точке HTTPS домена. Политика может иметь следующие значения:

  • Policy-Min-TLS-1-0-2019-07: Политика безопасности TLS, поддерживающая версии TLS от 1.0 до 1.2
  • Policy-Min-TLS-1-2-2019-07: Политика безопасности TLS, поддерживающая только версию TLS 1.2
  • Policy-Min-TLS-1-2-PFS-2023-10: Политика безопасности TLS, поддерживающая версии TLS от 1.2 до 1.3 с шифрами с совершенной прямой секретностью

CustomEndpointEnabled -> (булево)

Включить пользовательскую конечную точку для домена.

CustomEndpoint -> (строка)

Полный URL пользовательской конечной точки.

CustomEndpointCertificateArn -> (строка)

ARN вашего сертификата безопасности, управляемого в Amazon Web Services Certificate Manager (ACM).

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

Настройки для точного контроля доступа.

Enabled -> (булево)

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

InternalUserDatabaseEnabled -> (булево)

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

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

Контейнер для информации о конфигурации SAML для OpenSearch Dashboards.

Enabled -> (булево)

Истина, если SAML включен.

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

Описание информации поставщика идентификации SAML.

MetadataContent -> (строка)

Метаданные приложения SAML в формате XML.

EntityId -> (строка)

Уникальный идентификатор сущности приложения в поставщике идентификации SAML.

SubjectKey -> (строка)

Ключ для сопоставления атрибута субъекта SAML.

RolesKey -> (строка)

Ключ для сопоставления атрибута ролей SAML.

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

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

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

Контейнер для информации о конфигурации JWT службы Amazon OpenSearch.

Enabled -> (булево)

Истина, если используется JWT.

SubjectKey -> (строка)

Ключ для сопоставления атрибута субъекта JWT.

RolesKey -> (строка)

Ключ для сопоставления атрибута ролей JWT.

PublicKey -> (строка)

Ключ для проверки подписи входящих запросов JWT.

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

Дата и время, когда период миграции будет отключен. Необходимо только при включении точного контроля доступа на существующем домене.

AnonymousAuthEnabled -> (булево)

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

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

Параметры конфигурации для управления интеграцией IAM Identity Center в домене.

EnabledAPIAccess -> (булево)

Указывает, включена ли IAM Identity Center для приложения.

IdentityCenterInstanceARN -> (строка)

Amazon Resource Name (ARN) экземпляра IAM Identity Center.

SubjectKey -> (строка)

Указывает атрибут, содержащий идентификатор субъекта (например, имя пользователя, идентификатор пользователя или электронная почта) в IAM Identity Center.

RolesKey -> (строка)

Указывает атрибут, содержащий идентификатор роли бэкенда (например, имя группы или идентификатор группы) в IAM Identity Center.

IdentityCenterApplicationARN -> (строка)

ARN приложения IAM Identity Center, интегрированного со службой Amazon OpenSearch.

IdentityStoreId -> (строка)

Идентификатор магазина IAM Identity.

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

Настройки Авто-Настройки для домена.

State -> (строка)

Текущее состояние Авто-Настройки в домене.

ErrorMessage -> (строка)

Любые ошибки, возникшие при включении или отключении Авто-Настройки.

UseOffPeakWindow -> (булево)

Будет ли использоваться окно вне пиковых нагрузок домена для развертывания изменений Авто-Настройки вместо графика технического обслуживания.

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

Информация о конфигурации, происходящей на домене.

ChangeId -> (строка)

Идентификатор изменения конфигурации.

Message -> (строка)

Сообщение, соответствующее статусу изменения конфигурации.

ConfigChangeStatus -> (строка)

Текущий статус изменения конфигурации.

InitiatedBy -> (строка)

IAM-принципал, который инициировал изменение конфигурации.

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

Время инициирования изменения конфигурации в формате UTC.

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

Последнее время обновления изменения конфигурации.

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

Параметры, определяющие пользовательское 10-часовое окно, в течение которого OpenSearch Service может вносить изменения в конфигурацию домена.

Enabled -> (булево)

Включить окно вне пиковых нагрузок.

Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 года, а не при создании нового домена. Все домены, созданные после этой даты, имеют окно вне пиковых нагрузок по умолчанию. Вы не можете отключить окно вне пиковых нагрузок после его включения для домена.

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

Настройки окна вне пиковых нагрузок для домена.

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

Пользовательское время начала окна вне пиковых нагрузок в формате UTC. Длительность окна всегда составляет 10 часов, поэтому вы не можете указать конечное время. Например, если вы укажете 23:00 UTC как время начала, время окончания будет автоматически установлено на 9:00.

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

Часы начала окна в формате UTC (24-часовой формат). Например, 17 относится к 17:00 UTC.

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

Минуты начала окна в формате UTC.

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

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

AutoSoftwareUpdateEnabled -> (булево)

Включены ли автоматические обновления программного обеспечения службы для домена.

DomainProcessingStatus -> (строка)

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

ModifyingProperties -> (список)

Информация о свойствах домена, которые в настоящее время изменяются.

(структура)

Информация о свойствах домена, которые в настоящее время изменяются.

Name -> (строка)

Имя свойства, которое в настоящее время изменяется.

ActiveValue -> (строка)

Текущее значение свойства домена, которое изменяется.

PendingValue -> (строка)

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

ValueType -> (строка)

Тип значения, которое изменяется. Свойства могут иметь два типа:

  • PLAIN_TEXT : Содержат прямые значения, такие как «1», «True» или «c5.large.search».
  • STRINGIFIED_JSON : Содержат контент в формате JSON, например {“Enabled”:”True”}”.

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

Контейнер для параметров, необходимых для включения всех функций машинного обучения.

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

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

DesiredState -> (строка)

Желаемое состояние функции генерации запросов на естественном языке. Допустимые значения — ENABLED и DISABLED.

CurrentState -> (строка)

Текущее состояние функции генерации запросов на естественном языке, указывающее на завершение, выполнение или ошибку.

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

Spec-Zone.ru

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