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
<a name="API_GetSignalingChannelEndpoint"></a>

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`

 `Role`determina 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 um`MASTER`. 

## Sintaxe da Solicitação
<a name="API_GetSignalingChannelEndpoint_RequestSyntax"></a>

```
POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "{{string}}",
   "SingleMasterChannelEndpointConfiguration": { 
      "Protocols": [ "{{string}}" ],
      "Role": "{{string}}"
   }
}
```

## Parâmetros da solicitação de URI
<a name="API_GetSignalingChannelEndpoint_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_GetSignalingChannelEndpoint_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [ChannelARN](#API_GetSignalingChannelEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-request-ChannelARN"></a>
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. O comprimento máximo é 1.024.  
Padrão: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Obrigatório: Sim

 ** [SingleMasterChannelEndpointConfiguration](#API_GetSignalingChannelEndpoint_RequestSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-request-SingleMasterChannelEndpointConfiguration"></a>
Uma estrutura contendo a configuração do endpoint para o tipo de `SINGLE_MASTER` canal.  
Tipo: objeto [SingleMasterChannelEndpointConfiguration](API_SingleMasterChannelEndpointConfiguration.md)  
Obrigatório: não

## Sintaxe da resposta
<a name="API_GetSignalingChannelEndpoint_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ResourceEndpointList": [ 
      { 
         "Protocol": "string",
         "ResourceEndpoint": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_GetSignalingChannelEndpoint_ResponseElements"></a>

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](#API_GetSignalingChannelEndpoint_ResponseSyntax) **   <a name="KinesisVideo-GetSignalingChannelEndpoint-response-ResourceEndpointList"></a>
Uma lista de pontos finais para o canal de sinalização especificado.  
Tipo: matriz de objetos [ResourceEndpointListItem](API_ResourceEndpointListItem.md)

## Erros
<a name="API_GetSignalingChannelEndpoint_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** 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 `StreamARN` ou `ChannelARN` a entrada já estiverem mapeadas para um recurso diferente do Kinesis Video Stream, ou se a `StreamARN` entrada `ChannelARN` fornecida não estiver no status Ativo, tente uma das seguintes opções: `CLOUD_STORAGE_MODE`   

1. A `DescribeMediaStorageConfiguration` API para determinar para onde o stream determinado canal é mapeado. 

1. A `DescribeMappedResourceConfiguration` API para determinar o canal para o qual o determinado fluxo é mapeado. 

1. A `DescribeSignalingChannel` API `DescribeStream` ou 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
<a name="API_GetSignalingChannelEndpoint_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint)