describe-elasticsearch-domain-config
Описание
Предоставляет информацию о конфигурации кластера указанного домена Elasticsearch, например, состояние, дату создания, версию обновления и дату обновления параметров кластера.
См. также: Документация API AWS
Синтаксис
describe-elasticsearch-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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Получение подробной информации о конфигурации домена
Следующий describe-elasticsearch-domain-config пример предоставляет сведения о конфигурации для заданного домена, а также сведения о состоянии каждого компонента домена.
aws es describe-elasticsearch-domain-config \
--domain-name cli-example
Вывод:
{
"DomainConfig": {
"ElasticsearchVersion": {
"Options": "7.4",
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"ElasticsearchClusterConfig": {
"Options": {
"InstanceType": "c5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": true,
"ZoneAwarenessEnabled": false,
"DedicatedMasterType": "c5.large.elasticsearch",
"DedicatedMasterCount": 3,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.elasticsearch",
"WarmCount": 2
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"EBSOptions": {
"Options": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AccessPolicies": {
"Options": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example/*\"}]}",
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"SnapshotOptions": {
"Options": {
"AutomatedSnapshotStartHour": 0
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"VPCOptions": {
"Options": {},
"Status": {
"CreationDate": 1591210426.162,
"UpdateDate": 1591210426.162,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"CognitoOptions": {
"Options": {
"Enabled": false
},
"Status": {
"CreationDate": 1591210426.163,
"UpdateDate": 1591210426.163,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"EncryptionAtRestOptions": {
"Options": {
"Enabled": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"NodeToNodeEncryptionOptions": {
"Options": {
"Enabled": true
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AdvancedOptions": {
"Options": {
"rest.action.multi.allow_explicit_index": "true"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"LogPublishingOptions": {
"Options": {},
"Status": {
"CreationDate": 1591210426.164,
"UpdateDate": 1591210426.164,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"DomainEndpointOptions": {
"Options": {
"EnforceHTTPS": true,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AdvancedSecurityOptions": {
"Options": {
"Enabled": true,
"InternalUserDatabaseEnabled": true
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589827485.577,
"UpdateVersion": 14,
"State": "Active",
"PendingDeletion": false
}
}
}
}
Дополнительную информацию см. в разделе Создание и управление доменами Amazon Elasticsearch Service в руководстве разработчика Amazon Elasticsearch Service.
Вывод
DomainConfig -> (структура)
Информация о конфигурации домена, запрошенная в запросе DescribeElasticsearchDomainConfig.
ElasticsearchVersion -> (структура)
Строка формата X.Y для указания версии Elasticsearch домена.
Options -> (строка)
Status -> (структура)
Указывает состояние параметров версии Elasticsearch для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
ElasticsearchClusterConfig -> (структура)
Указывает ElasticsearchClusterConfig для домена Elasticsearch.
Options -> (структура)
Указывает конфигурацию кластера для указанного домена Elasticsearch.
InstanceType -> (строка)
InstanceCount -> (целое число)
DedicatedMasterEnabled -> (булево)
ZoneAwarenessEnabled -> (булево)
ZoneAwarenessConfig -> (структура)
Указывает конфигурацию зональной осведомленности для домена, когда зональная осведомленность включена.
AvailabilityZoneCount -> (целое число)
DedicatedMasterType -> (строка)
DedicatedMasterCount -> (целое число)
WarmEnabled -> (булево)
WarmType -> (строка)
WarmCount -> (целое число)
ColdStorageOptions -> (структура)
Указывает конфигурацию ColdStorageOptions для домена Elasticsearch
Enabled -> (булево)
Status -> (структура)
Указывает состояние конфигурации для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
EBSOptions -> (структура)
Указывает EBSOptions для домена Elasticsearch.
Options -> (структура)
Указывает параметры EBS для указанного домена Elasticsearch.
EBSEnabled -> (булево)
VolumeType -> (строка)
VolumeSize -> (целое число)
Iops -> (целое число)
Throughput -> (целое число)
Status -> (структура)
Указывает состояние параметров EBS для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
AccessPolicies -> (структура)
Политика доступа IAM в формате JSON.
Options -> (строка)
Status -> (структура)
Состояние политики доступа для домена Elasticsearch. См. OptionStatus для получения информации о состоянии.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
SnapshotOptions -> (структура)
Указывает SnapshotOptions для домена Elasticsearch.
Options -> (структура)
Указывает параметры ежедневного создания моментальных снимков для домена Elasticsearch.
AutomatedSnapshotStartHour -> (целое число)
0 часов.Status -> (структура)
Указывает состояние ежедневного автоматического моментального снимка.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
VPCOptions -> (структура)
VPCOptions для указанного домена. Дополнительную информацию см. в разделе VPC-шлюзы для домена Amazon Elasticsearch Service.
Options -> (структура)
Указывает параметры VPC для указанного домена Elasticsearch.
VPCId -> (строка)
SubnetIds -> (список)
Указывает подсети для VPC-шлюза.
(строка)
AvailabilityZones -> (список)
Зоны доступности для домена Elasticsearch. Существуют только если домен был создан с VPCOptions.
(строка)
SecurityGroupIds -> (список)
Указывает группы безопасности для VPC-шлюза.
(строка)
Status -> (структура)
Указывает состояние параметров VPC для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
CognitoOptions -> (структура)
CognitoOptions для указанного домена. Дополнительную информацию см. в разделе Аутентификация Amazon Cognito для Kibana.
Options -> (структура)
Указывает параметры Cognito для указанного домена Elasticsearch.
Enabled -> (булево)
UserPoolId -> (строка)
IdentityPoolId -> (строка)
RoleArn -> (строка)
Status -> (структура)
Указывает состояние параметров Cognito для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
EncryptionAtRestOptions -> (структура)
Указывает EncryptionAtRestOptions для домена Elasticsearch.
Options -> (структура)
Указывает параметры шифрования в состоянии покоя для указанного домена Elasticsearch.
Enabled -> (булево)
KmsKeyId -> (строка)
Status -> (структура)
Указывает состояние параметров шифрования в состоянии покоя для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
NodeToNodeEncryptionOptions -> (структура)
Указывает NodeToNodeEncryptionOptions для домена Elasticsearch.
Options -> (структура)
Указывает параметры шифрования между узлами для указанного домена Elasticsearch.
Enabled -> (булево)
Status -> (структура)
Указывает состояние параметров шифрования между узлами для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
AdvancedOptions -> (структура)
Указывает AdvancedOptions для домена. Для получения дополнительной информации см. Раздел Настройка дополнительных параметров.
Options -> (массив)
Указывает состояние расширенных параметров для указанного домена Elasticsearch.
key -> (строка)
value -> (строка)
Status -> (структура)
Указывает состояние OptionStatus для расширенных параметров указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
LogPublishingOptions -> (структура)
Параметры публикации логов для данного домена.
Options -> (массив)
Параметры публикации логов, настроенные для домена Elasticsearch.
key -> (строка)
Тип файла лога, может быть одним из следующих:
- INDEX_SLOW_LOGS: Логи медленных запросов индексирования содержат запросы вставки, которые выполнялись дольше, чем заданный порог для логов запросов индексирования.
- SEARCH_SLOW_LOGS: Логи медленных запросов поиска содержат запросы поиска, которые выполнялись дольше, чем заданный порог для логов запросов поиска.
- ES_APPLICATION_LOGS: Логи приложения Elasticsearch содержат информацию об ошибках и предупреждениях, возникающих во время работы сервиса, и могут быть полезны для устранения неполадок.
- AUDIT_LOGS: Логи аудита содержат записи о запросах пользователей для доступа к домену.
value -> (структура)
Параметр публикации логов, установленный для данного домена. Атрибуты и их подробности:
- CloudWatchLogsLogGroupArn: ARN группы логов CloudWatch, в которую необходимо опубликовать логи.
- Enabled: Включена ли публикация логов для данного типа лога.
CloudWatchLogsLogGroupArn -> (строка)
Enabled -> (булево)
Status -> (структура)
Состояние параметров публикации логов для домена Elasticsearch. См. OptionStatus для включенной информации о состоянии.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
DomainEndpointOptions -> (структура)
Указывает DomainEndpointOptions для домена Elasticsearch.
Options -> (структура)
Параметры для настройки конечной точки для домена Elasticsearch.
EnforceHTTPS -> (булево)
TLSSecurityPolicy -> (строка)
Укажите политику безопасности TLS, которая должна быть применена к HTTPS-конечной точке домена Elasticsearch. Может принимать одно из следующих значений:
- 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 -> (структура)
Состояние параметров конечной точки для домена Elasticsearch. См. OptionStatus для включенной информации о состоянии.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
AdvancedSecurityOptions -> (структура)
Указывает AdvancedSecurityOptions для домена.
Options -> (структура)
Указывает расширенные параметры безопасности для указанного домена Elasticsearch.
Enabled -> (булево)
InternalUserDatabaseEnabled -> (булево)
SAMLOptions -> (структура)
Описывает приложение SAML, настроенное для домена.
Enabled -> (булево)
Idp -> (структура)
Описывает информацию поставщика идентификации SAML.
MetadataContent -> (строка)
EntityId -> (строка)
SubjectKey -> (строка)
RolesKey -> (строка)
SessionTimeoutMinutes -> (целое число)
AnonymousAuthDisableDate -> (метка времени)
AnonymousAuthEnabled -> (булево)
Status -> (структура)
Состояние расширенных параметров безопасности для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
OptionState для домена Elasticsearch.PendingDeletion -> (булево)
AutoTuneOptions -> (структура)
Указывает AutoTuneOptions для домена.
Options -> (структура)
Указывает параметры Авто-тюнинга для указанного домена Elasticsearch.
DesiredState -> (строка)
RollbackOnDisable -> (строка)
MaintenanceSchedules -> (список)
Указывает список планов технического обслуживания. Для получения дополнительной информации см. руководство разработчика.
(структура)
Указывает план технического обслуживания Авто-тюнинга. Для получения дополнительной информации см. руководство разработчика.
StartAt -> (метка времени)
Duration -> (структура)
Указывает продолжительность плана технического обслуживания: значение и единица измерения. Для получения дополнительной информации см. руководство разработчика.
Value -> (длинное целое)
Unit -> (строка)
CronExpressionForRecurrence -> (строка)
Status -> (структура)
Указывает состояние параметров Авто-тюнинга для указанного домена Elasticsearch.
CreationDate -> (метка времени)
UpdateDate -> (метка времени)
UpdateVersion -> (целое число)
State -> (строка)
AutoTuneState для домена Elasticsearch.ErrorMessage -> (строка)
PendingDeletion -> (булево)
ChangeProgressDetails -> (структура)
Указывает подробности изменений конфигурации домена.
ChangeId -> (строка)
Message -> (строка)
ConfigChangeStatus -> (строка)
StartTime -> (метка времени)
LastUpdatedTime -> (метка времени)
InitiatedBy -> (строка)
ModifyingProperties -> (список)
Информация о свойствах домена, которые в настоящее время изменяются.
(структура)
Информация о свойствах домена, которые в настоящее время изменяются.
Имя -> (строка)
Активное значение -> (строка)
Ожидаемое значение -> (строка)
Тип значения -> (строка)
Тип значения, который в настоящее время изменяется. Свойства могут иметь два типа:
- Обычный текст : Содержат прямые значения, такие как «1», «True» или «c5.large.search».
- JSON в строковом формате : Содержат содержимое в формате JSON, например, {“Включено”:”True”}”.
© Copyright 2025, Amazon Web Services. Created using Sphinx.