[ aws . kinesisvideo ]
получение конечной точки канала сигнализации
Описание
Предоставляет конечную точку для указанного канала сигнализации для отправки и получения сообщений. Этот API использует параметр ввода SingleMasterChannelEndpointConfiguration, который состоит из свойств Protocols и Role.
Protocols используется для определения механизма связи. Например, если вы укажете WSS в качестве протокола, этот API создаёт защищённую конечную точку WebSocket. Если вы укажете HTTPS в качестве протокола, этот API сгенерирует конечную точку HTTPS.
Role определяет разрешения на обмен сообщениями. Роль MASTER приводит к тому, что этот API генерирует конечную точку, которую клиент может использовать для связи с любым из зрителей в канале. Роль VIEWER приводит к тому, что этот API генерирует конечную точку, которую клиент может использовать только для связи с конкретным MASTER.
См. также: Документацию API AWS
Синтаксис
get-signaling-channel-endpoint
--channel-arn <value>
[--single-master-channel-endpoint-configuration <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 (строка)
--single-master-channel-endpoint-configuration (структура)
Структура, содержащая конфигурацию конечной точки для типа канала SINGLE_MASTER.
Protocols -> (список)
Это свойство используется для определения характера связи через этот канал сигнализации SINGLE_MASTER. Если указано WSS, этот API возвращает конечную точку WebSocket. Если указано HTTPS, этот API возвращает конечную точку HTTPS.
(строка)
Role -> (строка)
SINGLE_MASTER. Если указана MASTER, этот API возвращает конечную точку, которую клиент может использовать для получения предложений и отправки ответов любому из зрителей в этом канале сигнализации. Если указана VIEWER, этот API возвращает конечную точку, которую клиент может использовать только для отправки предложений другому клиенту MASTER в этом канале сигнализации.Сокращённый синтаксис:
Protocols=string,string,Role=string
Синтаксис JSON:
{
"Protocols": ["WSS"|"HTTPS"|"WEBRTC", ...],
"Role": "MASTER"|"VIEWER"
}
--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.
Вывод
ResourceEndpointList -> (список)
Список конечных точек для указанного канала сигнализации.
(структура)
Объект, описывающий конечную точку канала сигнализации, возвращённую API GetSignalingChannelEndpoint.
Конечная точка медиа-сервера будет соответствовать протоколу WEBRTC.
Protocol -> (строка)
GetSignalingChannelEndpoint.ResourceEndpoint -> (строка)
GetSignalingChannelEndpoint.
© Copyright 2025, Amazon Web Services. Created using Sphinx.