[ aws . opensearch ]
describe-domain-config
Описание
Возвращает конфигурацию домена Amazon OpenSearch Service.
См. также: Документацию API AWS
Синтаксис
describe-domain-config
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать входные параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы входных параметров CLI.
Выходные данные
DomainConfig -> (структура)
Контейнер для конфигурации домена службы OpenSearch.
EngineVersion -> (структура)
Версия OpenSearch или Elasticsearch, на которой работает домен.
Options -> (строка)
Status -> (структура)
Статус параметров версии для указанного домена.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
ClusterConfig -> (структура)
Контейнер для конфигурации кластера домена.
Options -> (структура)
Параметры конфигурации кластера для указанного домена.
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 -> (целое число)
Status -> (структура)
Статус параметров конфигурации кластера для указанного домена.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
EBSOptions -> (структура)
Контейнер для параметров EBS, настроенных для домена.
Options -> (структура)
Настроенные параметры EBS для указанного домена.
EBSEnabled -> (булево)
VolumeType -> (строка)
VolumeSize -> (целое число)
Iops -> (целое число)
gp3 и типов томов EBS с предварительно заданной производительностью IOPS.Throughput -> (целое число)
gp3.Status -> (структура)
Статус параметров EBS для указанного домена.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
AccessPolicies -> (структура)
Указывает политики доступа к домену.
Options -> (строка)
Status -> (структура)
Статус политики доступа для домена.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
IPAddressType -> (структура)
Выберите двойную стек или IPv4 в качестве типа IP-адреса. Двойной стек позволяет обмениваться ресурсами домена между типами адресов IPv4 и IPv6 и является рекомендуемым вариантом. Если вы установите тип IP-адреса на двойной стек, изменить тип адреса позже нельзя.
Options -> (строка)
Status -> (структура)
Предоставляет текущий статус сущности.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
SnapshotOptions -> (структура)
УСТАНОВЛЕНО. Контейнер для параметров, необходимых для настройки автоматических снимков индексов домена.
Options -> (структура)
Указанные параметры ежедневных снимков для домена.
AutomatedSnapshotStartHour -> (целое число)
0 час.Status -> (структура)
Статус ежедневного автоматического снимка.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
VPCOptions -> (структура)
Текущие параметры VPC для домена и состояние любых обновлений их конфигурации.
Options -> (структура)
Параметры VPC для указанного домена.
VPCId -> (строка)
SubnetIds -> (список)
Список идентификаторов подсетей, связанных с точками входа VPC для домена.
(строка)
AvailabilityZones -> (список)
Список зон доступности, связанных с подсетями VPC.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности, связанных с точками входа VPC для домена.
(строка)
Status -> (структура)
Статус параметров VPC для указанного домена.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
CognitoOptions -> (структура)
Контейнер для параметров Amazon Cognito для домена.
Options -> (структура)
Параметры Cognito для указанного домена.
Enabled -> (булево)
UserPoolId -> (строка)
IdentityPoolId -> (строка)
RoleArn -> (строка)
AmazonOpenSearchServiceCognitoAccess роль, которая позволяет OpenSearch Service настроить ваш пул пользователей и пул идентификаторов.Status -> (структура)
Статус параметров Cognito для указанного домена.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
EncryptionAtRestOptions -> (структура)
Пара ключ-значение для включения шифрования данных при хранении.
Options -> (структура)
Параметры шифрования данных при хранении для указанного домена.
Enabled -> (булево)
KmsKeyId -> (строка)
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .Status -> (структура)
Статус параметров шифрования данных при хранении для указанного домена.
CreationDate -> (временная метка)
UpdateDate -> (временная метка)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
NodeToNodeEncryptionOptions -> (структура)
Включено или выключено шифрование между узлами.
Options -> (структура)
Параметры шифрования между узлами для указанного домена.
Enabled -> (булево)
Status -> (структура)
Статус параметров шифрования между узлами для указанного домена.
CreationDate -> (временная метка)
UpdateDate -> (временная метка)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
AdvancedOptions -> (структура)
Пара ключ-значение для указания параметров расширенной конфигурации. Дополнительную информацию см. в разделе Дополнительные параметры .
Options -> (карта)
Статус расширенных параметров для указанного домена.
key -> (строка)
value -> (строка)
Status -> (структура)
Статус расширенных параметров для указанного домена.
CreationDate -> (временная метка)
UpdateDate -> (временная метка)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
LogPublishingOptions -> (структура)
Пара ключ-значение для настройки публикации журналов.
Options -> (карта)
Параметры публикации журналов, настроенные для домена.
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 -> (булево)
Status -> (структура)
Статус параметров публикации журналов для домена.
CreationDate -> (временная метка)
UpdateDate -> (временная метка)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
DomainEndpointOptions -> (структура)
Дополнительные параметры для конечной точки домена, например, обязательное использование HTTPS для всего трафика.
Options -> (структура)
Параметры для настройки конечной точки домена.
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 -> (строка)
Status -> (структура)
Статус параметров конечной точки для домена.
CreationDate -> (временная метка)
UpdateDate -> (временная метка)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
AdvancedSecurityOptions -> (структура)
Контейнер для настроек доступа с точным управлением для домена.
Options -> (структура)
Контейнер для настроек доступа с точным управлением.
Enabled -> (булево)
InternalUserDatabaseEnabled -> (булево)
SAMLOptions -> (структура)
Контейнер с информацией о конфигурации SAML для OpenSearch Dashboards.
Enabled -> (булево)
Idp -> (структура)
Описание информации поставщика удостоверений SAML.
MetadataContent -> (строка)
EntityId -> (строка)
SubjectKey -> (строка)
RolesKey -> (строка)
SessionTimeoutMinutes -> (целое число)
JWTOptions -> (структура)
Контейнер с информацией о конфигурации JWT для Amazon OpenSearch Service.
Enabled -> (булево)
SubjectKey -> (строка)
RolesKey -> (строка)
PublicKey -> (строка)
AnonymousAuthDisableDate -> (временная метка)
AnonymousAuthEnabled -> (булево)
Status -> (структура)
Статус настроек доступа с точным управлением для домена.
CreationDate -> (временная метка)
UpdateDate -> (временная метка)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
IdentityCenterOptions -> (структура)
Параметры конфигурации для включения и управления интеграцией IAM Identity Center в домене.
Options -> (структура)
Настройки конфигурации для интеграции с IAM Identity Center.
EnabledAPIAccess -> (булево)
IdentityCenterInstanceARN -> (строка)
SubjectKey -> (строка)
RolesKey -> (строка)
IdentityCenterApplicationARN -> (строка)
IdentityStoreId -> (строка)
Status -> (структура)
Статус настроек конфигурации IAM Identity Center для домена.
CreationDate -> (временная метка)
UpdateDate -> (временная метка)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
AutoTuneOptions -> (структура)
Контейнер для настроек Авто-тюна для домена.
Параметры -> (структура)
Настройки Авто-тюна для обновления домена.
DesiredState -> (строка)
RollbackOnDisable -> (строка)
NO_ROLLBACK, чтобы сохранить все предыдущие настройки Авто-тюна, или DEFAULT_ROLLBACK, чтобы вернуться к значениям по умолчанию Службы OpenSearch. Если вы укажете DEFAULT_ROLLBACK, вы должны включить MaintenanceSchedule в запросе. В противном случае Служба OpenSearch не сможет выполнить откат.MaintenanceSchedules -> (список)
УСТАРЕЛО. Используйте вместо этого окно вне пиковой нагрузки.
Список графиков обслуживания, во время которых Авто-тюн может развернуть изменения.
(структура)
Примечание
Этот объект устарел. Используйте окно вне пиковой нагрузки домена для планирования оптимизаций Авто-тюна. Инструкции по миграции см. в статье о миграции с окон обслуживания Авто-тюна.График обслуживания Авто-тюна. Дополнительную информацию см. в статье Авто-тюн для Amazon OpenSearch Service.
StartAt -> (метка времени)
Duration -> (структура)
Продолжительность графика обслуживания. Например, "Duration": {"Value": 2, "Unit": "HOURS"}.
Value -> (целое число)
Unit -> (строка)
CronExpressionForRecurrence -> (строка)
UseOffPeakWindow -> (булево)
Status -> (структура)
Текущее состояние Авто-тюна для домена.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
ErrorMessage -> (строка)
PendingDeletion -> (булево)
ChangeProgressDetails -> (структура)
Контейнер для информации о ходе текущего изменения конфигурации.
ChangeId -> (строка)
Message -> (строка)
ConfigChangeStatus -> (строка)
InitiatedBy -> (строка)
StartTime -> (метка времени)
LastUpdatedTime -> (метка времени)
OffPeakWindowOptions -> (структура)
Контейнер для параметров окна вне пиковой нагрузки для домена.
Options -> (структура)
Настройки окна вне пиковой нагрузки домена.
Enabled -> (булево)
Включить ли окно вне пиковой нагрузки.
Этот параметр доступен только при изменении домена, созданного до 16 февраля 2023 года, а не при создании нового домена. Для всех доменов, созданных после этой даты, окно вне пиковой нагрузки включено по умолчанию. После включения окна вне пиковой нагрузки для домена его нельзя отключить.
OffPeakWindow -> (структура)
Настройки окна вне пиковой нагрузки для домена.
WindowStartTime -> (структура)
Настраиваемое начальное время окна вне пиковой нагрузки по всемирному координированному времени (UTC). Длительность окна всегда составляет 10 часов, поэтому вы не можете указать конечное время. Например, если вы укажете 23:00 UTC как начальное время, конечное время будет автоматически установлено на 9:00.
Hours -> (целое число)
17 соответствует 17:00 UTC.Minutes -> (целое число)
Status -> (структура)
Текущий статус параметров окна вне пиковой нагрузки.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
SoftwareUpdateOptions -> (структура)
Параметры обновления программного обеспечения для домена.
Options -> (структура)
Параметры обновления программного обеспечения службы для домена.
AutoSoftwareUpdateEnabled -> (булево)
Status -> (структура)
Статус параметров обновления программного обеспечения службы, включая дату создания и последнюю дату обновления.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
ModifyingProperties -> (список)
Информация о свойствах домена, которые в настоящее время изменяются.
(структура)
Информация о свойствах домена, которые в настоящее время изменяются.
Name -> (строка)
ActiveValue -> (строка)
PendingValue -> (строка)
ValueType -> (строка)
Тип значения, которое в настоящее время изменяется. Свойства могут иметь два типа:
-
PLAIN_TEXT: Содержат прямые значения, такие как «1», «True» или «c5.large.search». -
STRINGIFIED_JSON: Содержат содержимое в формате JSON, например {“Enabled”:”True”}”.
AIMLOptions -> (структура)
Контейнер для параметров, необходимых для включения всех функций машинного обучения.
Options -> (структура)
Параметры машинного обучения для указанного домена.
NaturalLanguageQueryGenerationOptions -> (структура)
Контейнер для параметров, необходимых для генерации запросов на естественном языке для указанного домена.
DesiredState -> (строка)
CurrentState -> (строка)
Status -> (структура)
Предоставляет текущий статус сущности.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
PendingDeletion -> (булево)
© Copyright 2025, Amazon Web Services. Created using Sphinx.