Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

describe-domain

Описание

Описывает конфигурацию домена Amazon OpenSearch Service для указанного домена, включая идентификатор домена, конечную точку сервиса домена и ARN домена.

См. также: AWS API Documentation

Синтаксис

  describe-domain
--domain-name <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-name (строка)

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

--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-auto-prompt (булево)

Автоматически запросить параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров CLI.

Вывод

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

Список, содержащий статус каждого указанного домена сервиса OpenSearch.

DomainId -> (строка)

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

DomainName -> (строка)

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

ARN -> (строка)

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

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

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

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

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

Endpoint -> (строка)

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

EndpointV2 -> (строка)

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

Endpoints -> (массив)

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

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

key -> (строка)

value -> (строка)

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

DomainEndpointV2HostedZoneId -> (строка)

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

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

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

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

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

EngineVersion -> (строка)

Версия OpenSearch или Elasticsearch, используемая домен, в формате Elasticsearch_X.Y или OpenSearch_X.Y.

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

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

InstanceType -> (строка)

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

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

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

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

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

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

Указывает, включены ли несколько зон доступности. Дополнительную информацию см. в разделе Настройка домена с несколькими зонами доступности в Amazon OpenSearch Service.

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

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

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

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

DedicatedMasterType -> (строка)

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

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

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

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

Включает ли кластер тёплую (warm) хранилище.

WarmType -> (строка)

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

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

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

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

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

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

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

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

Логическое значение, указывающее, включен ли домен с несколькими зонами доступности со вспомогательной зоной. Дополнительную информацию см. в разделе Настройка домена с несколькими зонами доступности в Amazon OpenSearch Service.

NodeOptions -> (список)

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

(структура)

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

NodeType -> (строка)

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

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

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

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

Логическое значение, указывающее, активен или неактивен определённый тип узла.

Type -> (строка)

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

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

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

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

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

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

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

VolumeType -> (строка)

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

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

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

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

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

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

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

AccessPolicies -> (строка)

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

IPAddressType -> (строка)

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

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

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

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

Время в формате UTC, когда OpenSearch Service выполняет ежедневный автоматический снимок указанного домена. По умолчанию — 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 user pool, который вы хотите использовать OpenSearch Service для аутентификации OpenSearch Dashboards.

IdentityPoolId -> (строка)

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

RoleArn -> (строка)

Роль AmazonOpenSearchServiceCognitoAccess, которая позволяет OpenSearch Service настроить ваш user pool и identity pool.

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

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

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

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

KmsKeyId -> (строка)

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

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

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

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

True, чтобы включить шифрование между узлами.

AdvancedOptions -> (массив)

Пара ключей-значений, определяющие дополнительные параметры конфигурации.

key -> (строка)

value -> (строка)

LogPublishingOptions -> (массив)

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

key -> (строка)

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

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

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

Указывает, публикует ли Amazon OpenSearch Service логи приложения OpenSearch и медленные логи в Amazon CloudWatch. Дополнительную информацию см. в разделе Мониторинг логов OpenSearch с помощью Amazon CloudWatch Logs.

Примечание

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

CloudWatchLogsLogGroupArn -> (строка)

Amazon Resource Name (ARN) группы CloudWatch Logs для публикации логов.

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

Публиковать ли лог.

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

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

CurrentVersion -> (string)

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

NewVersion -> (string)

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

UpdateAvailable -> (boolean)

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

Cancellable -> (boolean)

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

UpdateStatus -> (string)

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

Description -> (string)

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

AutomatedUpdateDate -> (timestamp)

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

OptionalDeployment -> (boolean)

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

DomainEndpointOptions -> (structure)

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

EnforceHTTPS -> (boolean)

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

TLSSecurityPolicy -> (string)

Укажите политику безопасности 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 -> (boolean)

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

CustomEndpoint -> (string)

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

CustomEndpointCertificateArn -> (string)

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

AdvancedSecurityOptions -> (structure)

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

Enabled -> (boolean)

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

InternalUserDatabaseEnabled -> (boolean)

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

SAMLOptions -> (structure)

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

Enabled -> (boolean)

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

Idp -> (structure)

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

MetadataContent -> (string)

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

EntityId -> (string)

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

SubjectKey -> (string)

Ключ, используемый для сопоставления атрибута субъекта SAML.

RolesKey -> (string)

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

SessionTimeoutMinutes -> (integer)

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

JWTOptions -> (structure)

Контейнер для информации о настройке JWT для Amazon OpenSearch Service.

Enabled -> (boolean)

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

SubjectKey -> (string)

Ключ, используемый для сопоставления атрибута субъекта JWT.

RolesKey -> (string)

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

PublicKey -> (string)

Ключ, используемый для проверки подписи входящих запросов JWT.

AnonymousAuthDisableDate -> (timestamp)

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

AnonymousAuthEnabled -> (boolean)

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

IdentityCenterOptions -> (structure)

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

EnabledAPIAccess -> (boolean)

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

IdentityCenterInstanceARN -> (string)

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

SubjectKey -> (string)

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

RolesKey -> (string)

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

IdentityCenterApplicationARN -> (string)

ARN приложения IAM Identity Center, которое интегрируется с Amazon OpenSearch Service.

IdentityStoreId -> (string)

Идентификатор хранилища IAM Identity.

AutoTuneOptions -> (structure)

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

State -> (string)

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

ErrorMessage -> (string)

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

UseOffPeakWindow -> (boolean)

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

ChangeProgressDetails -> (structure)

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

ChangeId -> (string)

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

Message -> (string)

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

ConfigChangeStatus -> (string)

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

InitiatedBy -> (string)

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

StartTime -> (timestamp)

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

LastUpdatedTime -> (timestamp)

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

OffPeakWindowOptions -> (structure)

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

Enabled -> (boolean)

Включить окно вне пиковых часов?

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

OffPeakWindow -> (structure)

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

WindowStartTime -> (structure)

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

Hours -> (long)

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

Minutes -> (long)

Начальная минута окна в формате UTC.

SoftwareUpdateOptions -> (structure)

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

AutoSoftwareUpdateEnabled -> (boolean)

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

DomainProcessingStatus -> (string)

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

ModifyingProperties -> (list)

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

(structure)

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

Name -> (string)

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

ActiveValue -> (string)

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

PendingValue -> (string)

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

ValueType -> (string)

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

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

AIMLOptions -> (structure)

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

NaturalLanguageQueryGenerationOptions -> (structure)

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

DesiredState -> (string)

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

CurrentState -> (string)

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

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

Spec-Zone.ru

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