Spec-Zone.ru › AWS CLI v2

[ aws . kinesis-video-signaling ]

get-ice-server-config

Описание

Получает информацию о конфигурации сервера Interactive Connectivity Establishment (ICE), включая URI, имя пользователя и пароль, которые можно использовать для настройки подключения WebRTC. Компонент ICE использует эту информацию о конфигурации для настройки подключения WebRTC, включая аутентификацию на сервере реле Traversal Using Relays around NAT (TURN).

TURN — это протокол, используемый для улучшения подключения приложений peer-to-peer. Предоставляя облачную реле-службу, TURN гарантирует, что подключение может быть установлено даже в том случае, если один или несколько узлов не могут установить прямое peer-to-peer подключение. Для получения дополнительной информации см. A REST API For Access To TURN Services.

Вы можете вызвать этот API для создания механизма резервного копирования на случай, если ни один из узлов не может установить прямое peer-to-peer подключение по каналу сигнализации. Для вызова этого API необходимо указать либо ARN канала сигнализации, либо идентификатор клиента.

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

Синтаксис

  get-ice-server-config
--channel-arn <value>
[--client-id <value>]
[--service <value>]
[--username <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]

Параметры

--channel-arn (строка)

ARN канала сигнализации, который используется для peer-to-peer подключения между настроенными узлами.

--client-id (строка)

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

--service (строка)

Указывает желаемую службу. В настоящее время TURN — единственное допустимое значение.

Возможные значения:

  • TURN

--username (строка)

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

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

Вывод

IceServerList -> (список)

Список объектов информации о серверах ICE.

(структура)

Структура для данных соединения сервера ICE.

Uris -> (список)

Массив URI, в формате, указанном в спецификации I-D.petithuguenin-behave-turn-uris. Эти URI предоставляют различные адреса и/или протоколы, которые могут быть использованы для доступа к серверу TURN.

(строка)

Username -> (строка)

Имя пользователя для входа на сервер ICE.

Password -> (строка)

Пароль для входа на сервер ICE.

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

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

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

Spec-Zone.ru

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