Spec-Zone.ru › AWS CLI v2

[ aws . es ]

describe-elasticsearch-domains

Описание

Возвращает информацию о конфигурации указанных доменов Elasticsearch, включая идентификатор домена, конечную точку домена и ARN домена.

См. также: Документация API AWS

Синтаксис

  describe-elasticsearch-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 (список)

Домены Elasticsearch, для которых требуется информация.

(строка)

Имя домена Elasticsearch. Имена доменов уникальны для доменов, принадлежащих учетной записи в определённой области AWS. Имена доменов начинаются с буквы или цифры и могут содержать следующие символы: a-z (строчные буквы), 0-9 и - (дефис).

Синтаксис:

"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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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-domains пример предоставляет подробности конфигурации для одного или нескольких доменов.

aws es describe-elasticsearch-domains \
    --domain-names cli-example-1 cli-example-2

Вывод:

{
    "DomainStatusList": [{
            "DomainId": "123456789012/cli-example-1",
            "DomainName": "cli-example-1",
            "ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-1",
            "Created": true,
            "Deleted": false,
            "Endpoint": "search-cli-example-1-1a2a3a4a5a6a7a8a9a0a.us-east-1.es.amazonaws.com",
            "Processing": false,
            "UpgradeProcessing": false,
            "ElasticsearchVersion": "7.4",
            "ElasticsearchClusterConfig": {
                "InstanceType": "c5.large.elasticsearch",
                "InstanceCount": 1,
                 "DedicatedMasterEnabled": true,
                "ZoneAwarenessEnabled": false,
                "DedicatedMasterType": "c5.large.elasticsearch",
                "DedicatedMasterCount": 3,
                "WarmEnabled": true,
                "WarmType": "ultrawarm1.medium.elasticsearch",
                "WarmCount": 2
            },
            "EBSOptions": {
                "EBSEnabled": true,
                "VolumeType": "gp2",
                "VolumeSize": 10
            },
            "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-1/*\"}]}",
            "SnapshotOptions": {
                "AutomatedSnapshotStartHour": 0
            },
            "CognitoOptions": {
                "Enabled": false
            },
            "EncryptionAtRestOptions": {
                "Enabled": true,
                "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
            },
            "NodeToNodeEncryptionOptions": {
                "Enabled": true
            },
            "AdvancedOptions": {
                "rest.action.multi.allow_explicit_index": "true"
            },
            "ServiceSoftwareOptions": {
                "CurrentVersion": "R20200522",
                "NewVersion": "",
                "UpdateAvailable": false,
                "Cancellable": false,
                "UpdateStatus": "COMPLETED",
                "Description": "There is no software update available for this domain.",
                "AutomatedUpdateDate": 0.0
            },
            "DomainEndpointOptions": {
                "EnforceHTTPS": true,
                "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
            },
            "AdvancedSecurityOptions": {
                "Enabled": true,
                "InternalUserDatabaseEnabled": true
            }
        },
        {
            "DomainId": "123456789012/cli-example-2",
            "DomainName": "cli-example-2",
            "ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-2",
            "Created": true,
            "Deleted": false,
            "Processing": true,
            "UpgradeProcessing": false,
            "ElasticsearchVersion": "7.4",
            "ElasticsearchClusterConfig": {
                "InstanceType": "r5.large.elasticsearch",
                "InstanceCount": 1,
                "DedicatedMasterEnabled": false,
                "ZoneAwarenessEnabled": false,
                "WarmEnabled": false
            },
            "EBSOptions": {
                "EBSEnabled": true,
                "VolumeType": "gp2",
                "VolumeSize": 10
            },
            "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-2/*\"}]}",
            "SnapshotOptions": {
                "AutomatedSnapshotStartHour": 0
            },
            "CognitoOptions": {
                "Enabled": false
            },
            "EncryptionAtRestOptions": {
                "Enabled": false
            },
            "NodeToNodeEncryptionOptions": {
                "Enabled": false
            },
            "AdvancedOptions": {
                "rest.action.multi.allow_explicit_index": "true"
            },
            "ServiceSoftwareOptions": {
                "CurrentVersion": "",
                "NewVersion": "",
                "UpdateAvailable": false,
                "Cancellable": false,
                "UpdateStatus": "COMPLETED",
                "Description": "There is no software update available for this domain.",
                "AutomatedUpdateDate": 0.0
            },
            "DomainEndpointOptions": {
                "EnforceHTTPS": false,
                "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
            },
            "AdvancedSecurityOptions": {
                "Enabled": false,
                "InternalUserDatabaseEnabled": false
            }
        }
    ]
}

Для получения дополнительной информации см. Создание и управление доменами Amazon Elasticsearch Service в Руководстве разработчика Amazon Elasticsearch Service.

Выходные данные

DomainStatusList -> (список)

Статус доменов, запрошенных в запросе DescribeElasticsearchDomains.

(структура)

Текущий статус Elasticsearch домена.

DomainId -> (строка)

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

DomainName -> (строка)

Имя Elasticsearch домена. Имена доменов уникальны для всех доменов, принадлежащих учётной записи в конкретном регионе AWS. Имена доменов начинаются с буквы или цифры и могут содержать следующие символы: a-z (строчные буквы), 0-9 и - (дефис).

ARN -> (строка)

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

Created -> (булево)

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

Deleted -> (булево)

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

Endpoint -> (строка)

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

Endpoints -> (массив)

Массив, содержащий конечные точки Elasticsearch домена, используемые для отправки запросов индексирования и поиска. Пример key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

ключ -> (строка)

значение -> (строка)

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

Processing -> (булево)

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

UpgradeProcessing -> (булево)

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

ElasticsearchVersion -> (строка)

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

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

InstanceType -> (строка)

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

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

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

DedicatedMasterEnabled -> (булево)

Булевое значение, указывающее, включён ли выделенный мастер-узел. Подробнее см. в разделе О выделенных мастер-узлах.

ZoneAwarenessEnabled -> (булево)

Булевое значение, указывающее, включена ли зональная осведомлённость. Дополнительная информация в разделе О зональной осведомлённости.

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

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

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

Целое число, указывающее количество доступных зон для домена при включённой зональной осведомлённости. Оно должно быть равно количеству подсетей, если включены VPC-конечные точки.

DedicatedMasterType -> (строка)

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

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

Общее количество выделенных мастер-узлов (активных и резервных) для кластера.

WarmEnabled -> (булево)

Истина, если включено тепловое хранилище.

WarmType -> (строка)

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

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

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

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

Указывает конфигурацию ColdStorageOptions для Elasticsearch домена.

Enabled -> (булево)

Включить опцию холодного хранилища. Принимает значения true или false.

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

EBSOptions для указанного домена. Подробнее см. в разделе Настройка хранилища на основе EBS.

EBSEnabled -> (булево)

Указывает, включено ли хранилище на основе EBS.

VolumeType -> (строка)

Указывает тип тома для хранилища на основе EBS.

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

Целое число, указывающее размер тома EBS.

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

Указывает IOPS для тома EBS с выделенными IOPS и типом GP3 (SSD).

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

Указывает пропускную способность для тома EBS типа GP3 (SSD).

AccessPolicies -> (строка)

Политика доступа IAM в формате JSON.

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

Указывает статус SnapshotOptions

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

Указывает время в формате UTC, когда служба выполняет ежедневный автоматический снимок указанного Elasticsearch домена. Значение по умолчанию — 0 часов.

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

VPCOptions для указанного домена. Дополнительную информацию см. в разделе VPC-конечные точки для Amazon Elasticsearch Service Domains.

VPCId -> (строка)

Идентификатор VPC для Elasticsearch домена. Существует только если домен был создан с VPCOptions.

SubnetIds -> (список)

Указывает подсети для VPC-конечной точки.

(строка)

AvailabilityZones -> (список)

Доступные зоны для Elasticsearch домена. Существует только если домен был создан с VPCOptions.

(строка)

SecurityGroupIds -> (список)

Указывает группы безопасности для VPC-конечной точки.

(строка)

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

CognitoOptions для указанного домена. Дополнительную информацию см. в разделе Amazon Cognito Authentication for Kibana.

Enabled -> (булево)

Указывает опцию для включения Cognito для аутентификации Kibana.

UserPoolId -> (строка)

Указывает идентификатор пула пользователей Cognito для аутентификации Kibana.

IdentityPoolId -> (строка)

Указывает идентификатор пула идентификаторов Cognito для аутентификации Kibana.

RoleArn -> (строка)

Указывает ARN роли, предоставляющей Elasticsearch разрешения на доступ к ресурсам Cognito.

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

Указывает статус EncryptionAtRestOptions.

Enabled -> (булево)

Указывает опцию для включения шифрования в состоянии покоя.

KmsKeyId -> (строка)

Указывает идентификатор KMS ключа для опций шифрования в состоянии покоя.

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

Указывает статус NodeToNodeEncryptionOptions.

Enabled -> (булево)

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

AdvancedOptions -> (массив)

Указывает состояние AdvancedOptions

ключ -> (строка)

значение -> (строка)

LogPublishingOptions -> (массив)

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

ключ -> (строка)

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

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

значение -> (структура)

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

  • CloudWatchLogsLogGroupArn: ARN группы логов CloudWatch, в которую необходимо опубликовать логи.
  • Enabled: Включена ли публикация логов для данного типа лога.

CloudWatchLogsLogGroupArn -> (строка)

ARN группы логов CloudWatch, в которую необходимо опубликовать логи.

Enabled -> (булево)

Указывает, включена ли данная опция публикации логов.

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

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

CurrentVersion -> (строка)

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

NewVersion -> (строка)

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

UpdateAvailable -> (булево)

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

Cancellable -> (булево)

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

UpdateStatus -> (строка)

Статус обновления программного обеспечения службы. Это поле может принимать следующие значения: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED и NOT_ELIGIBLE .

Description -> (строка)

Описание UpdateStatus .

AutomatedUpdateDate -> (временная метка)

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

OptionalDeployment -> (булево)

True, если обновление программного обеспечения службы никогда не происходит автоматически. False, если обновление программного обеспечения службы происходит автоматически после AutomatedUpdateDate .

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

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

EnforceHTTPS -> (булево)

Указать, должен ли быть включён только HTTPS-конечная точка для Elasticsearch домена.

TLSSecurityPolicy -> (строка)

Укажите политику безопасности TLS, которая должна быть применена к HTTPS-конечной точке Elasticsearch домена. Она может принимать одно из следующих значений:

  • Policy-Min-TLS-1-0-2019-07: Политика безопасности TLS, поддерживающая TLS версии 1.0 до TLS версии 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 до TLS версии 1.3 с совершенной передачей секретов (perfect forward secrecy).

CustomEndpointEnabled -> (булево)

Указать, должна ли быть включена настраиваемая конечная точка для Elasticsearch домена.

CustomEndpoint -> (строка)

Укажите полное доменное имя для вашей настраиваемой конечной точки.

CustomEndpointCertificateArn -> (строка)

Укажите ARN сертификата ACM для вашей настраиваемой конечной точки.

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

Текущий статус расширенных параметров безопасности домена Elasticsearch.

Enabled -> (boolean)

Истина, если расширенная безопасность включена.

InternalUserDatabaseEnabled -> (boolean)

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

SAMLOptions -> (structure)

Описание приложения SAML, настроенного для домена.

Enabled -> (boolean)

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

Idp -> (structure)

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

MetadataContent -> (string)

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

EntityId -> (string)

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

SubjectKey -> (string)

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

RolesKey -> (string)

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

SessionTimeoutMinutes -> (integer)

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

AnonymousAuthDisableDate -> (timestamp)

Указывает дату отключения анонимной авторизации, когда анонимная авторизация включена.

AnonymousAuthEnabled -> (boolean)

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

AutoTuneOptions -> (structure)

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

State -> (string)

Указывает AutoTuneState для домена Elasticsearch.

ErrorMessage -> (string)

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

ChangeProgressDetails -> (structure)

Указывает детали изменений в конфигурации домена.

ChangeId -> (string)

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

Message -> (string)

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

ConfigChangeStatus -> (string)

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

StartTime -> (timestamp)

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

LastUpdatedTime -> (timestamp)

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

InitiatedBy -> (string)

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

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”}”.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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