Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
GetSignalingChannelEndpoint
Proporciona un punto final para que el canal de señalización especificado envíe y reciba mensajes. Esta API usa el parámetroSingleMasterChannelEndpointConfiguration de entrada, que consiste en lasRole propiedadesProtocols y.
Protocolsse utiliza para determinar el mecanismo de comunicación. Por ejemplo, si loWSS especificas como protocolo, esta API produce un punto final de websocket seguro. Si loHTTPS especificas como protocolo, esta API genera un punto final HTTPS.
Roledetermina los permisos de mensajería. UnMASTER rol hace que esta API genere un punto final que el cliente puede usar para comunicarse con cualquiera de los espectadores del canal. UnVIEWER rol hace que esta API genere un punto final que un cliente solo puede usar para comunicarse con unMASTER.
Sintaxis de la solicitud
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"SingleMasterChannelEndpointConfiguration": {
"Protocols": [ "string" ],
"Role": "string"
}
}Parámetros de solicitud del URI
La solicitud no utiliza ningún parámetro de URI.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- ChannelARN
-
El nombre de recurso de Amazon (ARN) del canal de señalización para el que desea obtener un punto de conexión.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Obligatorio: sí
- SingleMasterChannelEndpointConfiguration
-
Estructura que contiene la configuración de punto final para el tipo de
SINGLE_MASTERcanal.Tipo: objeto SingleMasterChannelEndpointConfiguration
Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"ResourceEndpointList": [
{
"Protocol": "string",
"ResourceEndpoint": "string"
}
]
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- ResourceEndpointList
-
Una lista de puntos finales del canal de señalización especificado.
Tipo: Matriz de objetos ResourceEndpointListItem
Errores
Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
No tiene los permisos necesarios para realizar esta operación.
Código de estado HTTP: 401
- ClientLimitExceededException
-
Kinesis Video Streams ha limitado la solicitud porque ha superado el límite de llamadas de cliente permitidas. Intenta hacer la llamada más tarde.
Código de estado HTTP: 400
- InvalidArgumentException
-
El valor de este parámetro de entrada no es válido.
Código de estado HTTP: 400
- ResourceInUseException
-
Cuando la entrada
StreamARNoChannelARNentrada yaCLOUD_STORAGE_MODEesté asignada a otro recurso de Kinesis Video Stream, o si la entradaStreamARNproporcionada noChannelARNestá en estado activo, pruebe una de las siguientes opciones:-
La
DescribeMediaStorageConfigurationAPI para determinar a qué se asigna el canal determinado de la transmisión. -
La
DescribeMappedResourceConfigurationAPI para determinar el canal al que se asigna la transmisión dada. -
La
DescribeSignalingChannelAPIDescribeStreamo para determinar el estado del recurso.
Código de estado HTTP: 400
-
- ResourceNotFoundException
-
Amazon Kinesis Video Streams no encuentra la transmisión que especificó.
Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
