As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
ListSignalingChannels
Retorna uma matriz de ChannelInfo objetos. Cada objeto descreve um canal de sinalização. Para recuperar somente os canais que satisfazem uma condição específica, você pode especificar a. ChannelNameCondition
Sintaxe da Solicitação
POST /listSignalingChannels HTTP/1.1
Content-type: application/json
{
"ChannelNameCondition": {
"ComparisonOperator": "string",
"ComparisonValue": "string"
},
"MaxResults": number,
"NextToken": "string"
}Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
- ChannelNameCondition
-
Opcional: retorna somente os canais que satisfazem uma condição específica.
Tipo: objeto ChannelNameCondition
Obrigatório: Não
- MaxResults
-
O número máximo de canais a serem retornados na resposta. O padrão é 500.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 10000.
Obrigatório: não
- NextToken
-
Se você especificar esse parâmetro, quando o resultado de uma
ListSignalingChannelsoperação for truncado, a chamada retornará oNextTokenna resposta. Para obter outro lote de canais, forneça esse token em sua próxima solicitação.Tipo: string
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 512.
Padrão:
[a-zA-Z0-9+/=]*Obrigatório: Não
Sintaxe da Resposta
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 Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- ChannelInfoList
-
Uma matriz de objetos
ChannelInfo.Tipo: matriz de objetos ChannelInfo
- NextToken
-
Se a resposta for truncada, a chamada retornará esse elemento com um token. Para obter o próximo lote de streams, use esse token em sua próxima solicitação.
Tipo: string
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 512.
Padrão:
[a-zA-Z0-9+/=]*
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- AccessDeniedException
-
Você não tem as permissões necessárias para realizar essa operação.
Código de status HTTP: 401
- ClientLimitExceededException
-
O Kinesis Video Streams limitou a solicitação porque você excedeu o limite permitido de chamadas de clientes. Tente fazer a ligação mais tarde.
Código de Status HTTP: 400
- InvalidArgumentException
-
O valor desse parâmetro de entrada é inválido.
Código de Status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
