[ 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, для которых требуется информация. Необходимо указать хотя бы одно имя домена.
(строка)
Синтаксис:
"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 -> (строка)
ARN -> (строка)
Created -> (булево)
Deleted -> (булево)
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 -> (булево)
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 настроить ваш пул пользователей и пул идентификаторов.EncryptionAtRestOptions -> (структура)
Настройки шифрования в состоянии покоя для домена.
Enabled -> (булево)
KmsKeyId -> (строка)
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.NodeToNodeEncryptionOptions -> (структура)
Включено или выключено шифрование между узлами.
Enabled -> (булево)
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 -> (строка)
Enabled -> (булево)
ServiceSoftwareOptions -> (структура)
Текущий статус программного обеспечения службы домена.
CurrentVersion -> (строка)
NewVersion -> (строка)
UpdateAvailable -> (булево)
Cancellable -> (булево)
UpdateStatus -> (строка)
Description -> (строка)
AutomatedUpdateDate -> (отметка времени)
OptionalDeployment -> (булево)
DomainEndpointOptions -> (структура)
Дополнительные параметры для конечной точки домена, такие как требование HTTPS для всего трафика.
EnforceHTTPS -> (булево)
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 -> (строка)
CustomEndpointCertificateArn -> (строка)
AdvancedSecurityOptions -> (структура)
Настройки для точного контроля доступа.
Enabled -> (булево)
InternalUserDatabaseEnabled -> (булево)
SAMLOptions -> (структура)
Контейнер для информации о конфигурации SAML для OpenSearch Dashboards.
Enabled -> (булево)
Idp -> (структура)
Описание информации поставщика идентификации SAML.
MetadataContent -> (строка)
EntityId -> (строка)
SubjectKey -> (строка)
RolesKey -> (строка)
SessionTimeoutMinutes -> (целое число)
JWTOptions -> (структура)
Контейнер для информации о конфигурации JWT службы Amazon OpenSearch.
Enabled -> (булево)
SubjectKey -> (строка)
RolesKey -> (строка)
PublicKey -> (строка)
AnonymousAuthDisableDate -> (отметка времени)
AnonymousAuthEnabled -> (булево)
IdentityCenterOptions -> (структура)
Параметры конфигурации для управления интеграцией IAM Identity Center в домене.
EnabledAPIAccess -> (булево)
IdentityCenterInstanceARN -> (строка)
SubjectKey -> (строка)
RolesKey -> (строка)
IdentityCenterApplicationARN -> (строка)
IdentityStoreId -> (строка)
AutoTuneOptions -> (структура)
Настройки Авто-Настройки для домена.
State -> (строка)
ErrorMessage -> (строка)
UseOffPeakWindow -> (булево)
ChangeProgressDetails -> (структура)
Информация о конфигурации, происходящей на домене.
ChangeId -> (строка)
Message -> (строка)
ConfigChangeStatus -> (строка)
InitiatedBy -> (строка)
StartTime -> (отметка времени)
LastUpdatedTime -> (отметка времени)
OffPeakWindowOptions -> (структура)
Параметры, определяющие пользовательское 10-часовое окно, в течение которого OpenSearch Service может вносить изменения в конфигурацию домена.
Enabled -> (булево)
Включить окно вне пиковых нагрузок.
Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 года, а не при создании нового домена. Все домены, созданные после этой даты, имеют окно вне пиковых нагрузок по умолчанию. Вы не можете отключить окно вне пиковых нагрузок после его включения для домена.
OffPeakWindow -> (структура)
Настройки окна вне пиковых нагрузок для домена.
WindowStartTime -> (структура)
Пользовательское время начала окна вне пиковых нагрузок в формате UTC. Длительность окна всегда составляет 10 часов, поэтому вы не можете указать конечное время. Например, если вы укажете 23:00 UTC как время начала, время окончания будет автоматически установлено на 9:00.
Hours -> (целое число)
17 относится к 17:00 UTC.Minutes -> (целое число)
SoftwareUpdateOptions -> (структура)
Параметры обновления программного обеспечения службы для домена.
AutoSoftwareUpdateEnabled -> (булево)
DomainProcessingStatus -> (строка)
ModifyingProperties -> (список)
Информация о свойствах домена, которые в настоящее время изменяются.
(структура)
Информация о свойствах домена, которые в настоящее время изменяются.
Name -> (строка)
ActiveValue -> (строка)
PendingValue -> (строка)
ValueType -> (строка)
Тип значения, которое изменяется. Свойства могут иметь два типа:
-
PLAIN_TEXT: Содержат прямые значения, такие как «1», «True» или «c5.large.search». -
STRINGIFIED_JSON: Содержат контент в формате JSON, например {“Enabled”:”True”}”.
AIMLOptions -> (структура)
Контейнер для параметров, необходимых для включения всех функций машинного обучения.
NaturalLanguageQueryGenerationOptions -> (структура)
Контейнер для параметров, необходимых для генерации запросов на естественном языке в указанном домене.
DesiredState -> (строка)
CurrentState -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.