[ aws . opensearch ]
describe-outbound-connections
Описание
Отображает все исходящие межкластерные подключения для локального (исходного) домена Amazon OpenSearch Service. Дополнительную информацию можно найти в разделе Поиск между кластерами для Amazon OpenSearch Service.
См. также: Документация API AWS
Синтаксис
describe-outbound-connections
[--filters <value>]
[--max-results <value>]
[--next-token <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]
Параметры
--filters (список)
Список имён и значений фильтров, которые можно использовать для запросов.
(структура)
Фильтр, используемый для ограничения результатов при описании входящих или исходящих межкластерных подключений. Вы можете указать несколько значений для каждого фильтра. Межкластерное подключение должно соответствовать хотя бы одному из указанных значений, чтобы оно было возвращено операцией.
Имя -> (строка)
Значения -> (список)
Одно или несколько значений для фильтра.
(строка)
Сокращённый синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--max-results (целое число)
nextToken, чтобы получить следующую страницу результатов.--next-token (строка)
DescribeOutboundConnections операция возвращает nextToken, вы можете включить полученную nextToken в последующие DescribeOutboundConnections операции, которая вернёт результаты на следующей странице.--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.
Вывод
Connections -> (список)
Список исходящих подключений, соответствующих критериям фильтрации.
(структура)
Указывает подробности об исходящем межкластерном подключении.
LocalDomainInfo -> (структура)
Информация об исходном (локальном) домене.
AWSDomainInformation -> (структура)
Информация о домене Amazon OpenSearch Service.
OwnerId -> (строка)
DomainName -> (строка)
Region -> (строка)
RemoteDomainInfo -> (структура)
Информация о целевом (удалённом) домене.
AWSDomainInformation -> (структура)
Информация о домене Amazon OpenSearch Service.
OwnerId -> (строка)
DomainName -> (строка)
Region -> (строка)
ConnectionId -> (строка)
ConnectionAlias -> (строка)
ConnectionStatus -> (структура)
Статус подключения.
StatusCode -> (строка)
Код состояния исходящего подключения. Может быть одним из следующих:
- VALIDATING - Запрос на исходящее подключение проверяется.
- VALIDATION_FAILED - Проверка подключения не удалась.
- PENDING_ACCEPTANCE : Запрос на исходящее подключение проверен, но ещё не принят владельцем удалённого домена.
- APPROVED - Исходящее подключение одобрено владельцем удалённого домена для подготовки.
- PROVISIONING - Запрос на исходящее подключение находится в процессе обработки.
- ACTIVE - Исходящее подключение активное и готово к использованию.
- REJECTING - Отклонение исходящего подключения владельцем удалённого домена находится в процессе.
- REJECTED - Запрос на исходящее подключение отклонен владельцем удалённого домена.
- DELETING - Удаление исходящего подключения находится в процессе.
- DELETED - Исходящее подключение удалено и больше не может быть использовано.
Message -> (строка)
ConnectionMode -> (строка)
ConnectionProperties -> (структура)
Свойства исходящего подключения.
Endpoint -> (строка)
Предупреждение
Атрибут Endpoint изменить нельзя.Точка входа удалённого домена. Применимо для режима подключения VPC_ENDPOINT.
CrossClusterSearch -> (структура)
Свойства подключения для поиска между кластерами.
SkipUnavailable -> (строка)
SkipUnavailable для исходящего подключения. Эта функция позволяет указать некоторые кластеры как необязательные и гарантировать, что ваши межкластерные запросы вернут частичные результаты, несмотря на сбои в одном или нескольких удалённых кластерах.NextToken -> (строка)
nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер пагинации для каждой страницы. Отправьте запрос снова, используя возвращённый маркер, чтобы получить следующую страницу.
© Copyright 2025, Amazon Web Services. Created using Sphinx.