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á.
DescribeSignalingChannel
Retorna as informações mais atuais sobre o canal de sinalização. Você deve especificar o nome ou o Amazon Resource Name (ARN) do canal que você deseja descrever.
Sintaxe da Solicitação
POST /describeSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ChannelName": "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.
- ChannelARN
-
O ARN do canal de sinalização que você deseja descrever.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.
Padrão:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Obrigatório: não
- ChannelName
-
O nome do canal de sinalização que você deseja descrever.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 256.
Padrão:
[a-zA-Z0-9_.-]+Obrigatório: Não
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfo": {
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "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.
- ChannelInfo
-
Uma estrutura que encapsula os metadados e as propriedades do canal de sinalização especificado.
Tipo: objeto ChannelInfo
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
- ResourceNotFoundException
-
O Amazon Kinesis Video Streams não consegue encontrar o stream que você especificou.
Código de Status HTTP: 404
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:
