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.
ListSignalingChannels
Devuelve una matriz de ChannelInfo objetos. Cada objeto describe un canal de señalización. Para recuperar solo los canales que cumplen una condición específica, puede especificar unChannelNameCondition.
Sintaxis de la solicitud
POST /listSignalingChannels HTTP/1.1
Content-type: application/json
{
"ChannelNameCondition": {
"ComparisonOperator": "string",
"ComparisonValue": "string"
},
"MaxResults": number,
"NextToken": "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.
- ChannelNameCondition
-
Opcional: devuelve solo los canales que cumplen una condición específica.
Tipo: objeto ChannelNameCondition
Obligatorio: no
- MaxResults
-
El número máximo de canales que se devolverán en la respuesta. El valor predeterminado es 500.
Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 10000.
Obligatorio: no
- NextToken
-
Si especifica este parámetro, cuando el resultado de una
ListSignalingChannelsoperación se trunca, la llamada devuelve el valorNextTokenen la respuesta. Para obtener otro lote de canales, proporciona este token en tu próxima solicitud.Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es 512.
Patrón:
[a-zA-Z0-9+/=]*Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfoList": [
{
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "string"
}
],
"NextToken": "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.
- ChannelInfoList
-
Una matriz de objetos
ChannelInfo.Tipo: matriz de objetos ChannelInfo
- NextToken
-
Si la respuesta está truncada, la llamada devuelve este elemento con un token. Para obtener el siguiente lote de transmisiones, usa este token en tu próxima solicitud.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es 512.
Patrón:
[a-zA-Z0-9+/=]*
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AccessDeniedException
-
No tienes 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 clientes permitidas. Intente realizar 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
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente:
