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á.
GetSignalingChannelEndpoint
Fornece um endpoint para o canal de sinalização especificado para enviar e receber mensagens. Essa API usa o parâmetro SingleMasterChannelEndpointConfiguration de entrada, que consiste nas Role propriedades Protocols e.
Protocolsé usado para determinar o mecanismo de comunicação. Por exemplo, se você especificar WSS como protocolo, essa API produzirá um endpoint seguro de websocket. Se você especificar HTTPS como protocolo, essa API gerará um endpoint HTTPS. Se você especificar WEBRTC como protocolo, mas o canal de sinalização não estiver configurado para ingestão, você receberá o erro. InvalidArgumentException
Roledetermina as permissões de mensagens. Uma MASTER função faz com que essa API gere um endpoint que um cliente pode usar para se comunicar com qualquer um dos espectadores no canal. Uma VIEWER função faz com que essa API gere um endpoint que um cliente pode usar para se comunicar somente com umMASTER.
Sintaxe da Solicitação
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"SingleMasterChannelEndpointConfiguration": {
"Protocols": [ "string" ],
"Role": "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 Amazon Resource Name (ARN) do canal de sinalização para o qual você deseja obter um endpoint.
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]+Exigido: Sim
- SingleMasterChannelEndpointConfiguration
-
Uma estrutura contendo a configuração do endpoint para o tipo de
SINGLE_MASTERcanal.Tipo: objeto SingleMasterChannelEndpointConfiguration
Obrigatório: Não
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"ResourceEndpointList": [
{
"Protocol": "string",
"ResourceEndpoint": "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.
- ResourceEndpointList
-
Uma lista de pontos finais para o canal de sinalização especificado.
Tipo: matriz de objetos ResourceEndpointListItem
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
- ResourceInUseException
-
Quando a entrada
StreamARNouChannelARNa entrada já estiverem mapeadas para um recurso diferente do Kinesis Video Stream, ou se aStreamARNentradaChannelARNfornecida não estiver no status Ativo, tente uma das seguintes opções:CLOUD_STORAGE_MODE-
A
DescribeMediaStorageConfigurationAPI para determinar para onde o stream determinado canal é mapeado. -
A
DescribeMappedResourceConfigurationAPI para determinar o canal para o qual o determinado fluxo é mapeado. -
A
DescribeSignalingChannelAPIDescribeStreamou para determinar o status do recurso.
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:
