[ 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 -> (строка)
ARN -> (строка)
Created -> (логическое значение)
Deleted -> (логическое значение)
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 -> (логическое значение)
UpgradeProcessing -> (логическое значение)
EngineVersion -> (строка)
Elasticsearch_X.Y или OpenSearch_X.Y.ClusterConfig -> (структура)
Контейнер для конфигурации кластера домена.
InstanceType -> (строка)
InstanceCount -> (целое число)
DedicatedMasterEnabled -> (логическое значение)
ZoneAwarenessEnabled -> (логическое значение)
ZoneAwarenessConfig -> (структура)
Контейнер для параметров конфигурации с учетом зон доступности. Требуется только если ZoneAwarenessEnabled равно true.
AvailabilityZoneCount -> (целое число)
2 и 3. Если ваш домен развернут в VPC, это значение будет равно количеству подсетей.DedicatedMasterType -> (строка)
DedicatedMasterCount -> (целое число)
WarmEnabled -> (логическое значение)
WarmType -> (строка)
WarmCount -> (целое число)
ColdStorageOptions -> (структура)
Контейнер для параметров конфигурации холодного хранения.
Enabled -> (логическое значение)
MultiAZWithStandbyEnabled -> (логическое значение)
NodeOptions -> (список)
Список параметров узлов для домена.
(структура)
Параметры настройки для определения типа узла в кластере.
NodeType -> (строка)
NodeConfig -> (структура)
Параметры настройки для определения конфигурации любого типа узла.
Enabled -> (логическое значение)
Type -> (строка)
Count -> (целое число)
EBSOptions -> (структура)
Контейнер для параметров хранилища EBS для домена.
EBSEnabled -> (логическое значение)
VolumeType -> (строка)
VolumeSize -> (целое число)
Iops -> (целое число)
gp3 и с предоставленной производительностью IOPS.Throughput -> (целое число)
gp3.AccessPolicies -> (строка)
IPAddressType -> (строка)
SnapshotOptions -> (структура)
УСТАРЕЛО. Контейнер для параметров, необходимых для настройки автоматических снимков индексов домена.
AutomatedSnapshotStartHour -> (целое число)
0 часов.VPCOptions -> (структура)
Конфигурация VPC для домена.
VPCId -> (строка)
SubnetIds -> (список)
Список идентификаторов подсетей, связанных с VPC-конечными точками для домена.
(строка)
AvailabilityZones -> (список)
Список зон доступности, связанных с подсетями VPC.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности, связанных с VPC-конечными точками для домена.
(строка)
CognitoOptions -> (структура)
Пара ключей-значений для настройки аутентификации Amazon Cognito для OpenSearch Dashboards.
Enabled -> (логическое значение)
UserPoolId -> (строка)
IdentityPoolId -> (строка)
RoleArn -> (строка)
AmazonOpenSearchServiceCognitoAccess, которая позволяет OpenSearch Service настроить ваш user pool и identity pool.EncryptionAtRestOptions -> (структура)
Настройки шифрования данных в состоянии покоя для домена.
Enabled -> (логическое значение)
KmsKeyId -> (строка)
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.NodeToNodeEncryptionOptions -> (структура)
Включено или выключено шифрование между узлами.
Enabled -> (логическое значение)
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 -> (строка)
Enabled -> (логическое значение)
ServiceSoftwareOptions -> (структура)
Текущее состояние программного обеспечения службы домена.
CurrentVersion -> (string)
NewVersion -> (string)
UpdateAvailable -> (boolean)
Cancellable -> (boolean)
UpdateStatus -> (string)
Description -> (string)
AutomatedUpdateDate -> (timestamp)
OptionalDeployment -> (boolean)
DomainEndpointOptions -> (structure)
Дополнительные параметры для конечной точки домена, такие как необходимость использования HTTPS для всего трафика.
EnforceHTTPS -> (boolean)
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)
CustomEndpointCertificateArn -> (string)
AdvancedSecurityOptions -> (structure)
Настройки для точного контроля доступа.
Enabled -> (boolean)
InternalUserDatabaseEnabled -> (boolean)
SAMLOptions -> (structure)
Контейнер для информации о настройке SAML для OpenSearch Dashboards.
Enabled -> (boolean)
Idp -> (structure)
Описание информации поставщика идентификации SAML.
MetadataContent -> (string)
EntityId -> (string)
SubjectKey -> (string)
RolesKey -> (string)
SessionTimeoutMinutes -> (integer)
JWTOptions -> (structure)
Контейнер для информации о настройке JWT для Amazon OpenSearch Service.
Enabled -> (boolean)
SubjectKey -> (string)
RolesKey -> (string)
PublicKey -> (string)
AnonymousAuthDisableDate -> (timestamp)
AnonymousAuthEnabled -> (boolean)
IdentityCenterOptions -> (structure)
Параметры конфигурации для управления интеграцией IAM Identity Center в домене.
EnabledAPIAccess -> (boolean)
IdentityCenterInstanceARN -> (string)
SubjectKey -> (string)
RolesKey -> (string)
IdentityCenterApplicationARN -> (string)
IdentityStoreId -> (string)
AutoTuneOptions -> (structure)
Настройки автоматической настройки для домена.
State -> (string)
ErrorMessage -> (string)
UseOffPeakWindow -> (boolean)
ChangeProgressDetails -> (structure)
Информация о происходящих изменениях конфигурации в домене.
ChangeId -> (string)
Message -> (string)
ConfigChangeStatus -> (string)
InitiatedBy -> (string)
StartTime -> (timestamp)
LastUpdatedTime -> (timestamp)
OffPeakWindowOptions -> (structure)
Параметры, указывающие пользовательское 10-часовое окно, в течение которого OpenSearch Service может выполнять изменения конфигурации в домене.
Enabled -> (boolean)
Включить окно вне пиковых часов?
Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 года, а не при создании нового домена. Во всех доменах, созданных после этой даты, окно вне пиковых часов включено по умолчанию. После включения окна вне пиковых часов для домена его нельзя отключить.
OffPeakWindow -> (structure)
Настройки окна вне пиковых часов для домена.
WindowStartTime -> (structure)
Пользовательское начальное время окна вне пиковых часов в формате UTC. Длина окна всегда составляет 10 часов, поэтому указать конечное время нельзя. Например, если вы укажете 23:00 UTC как начальное время, конечное время будет автоматически установлено на 9:00.
Hours -> (long)
17 соответствует 17:00 UTC.Minutes -> (long)
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)
CurrentState -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.