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á.

# GetIceServerConfig
<a name="API_signaling_GetIceServerConfig"></a>

 **Observação:** antes de usar essa API, você deve chamar a `GetSignalingChannelEndpoint` API para solicitar o endpoint HTTPS. Em seguida, você especifica o endpoint e a região na sua solicitação de `GetIceServerConfig` API.

Obtém as informações de configuração do servidor Interactive Connectivity Establishment (ICE) URIs, incluindo nome de usuário e senha, que podem ser usados para configurar a conexão WebRTC. O componente ICE usa essas informações de configuração para configurar a conexão WebRTC, incluindo a autenticação com o servidor de retransmissão Traversal Using Relays around NAT (TURN). 

TURN é um protocolo usado para melhorar a conectividade dos peer-to-peer aplicativos. Ao fornecer um serviço de retransmissão baseado em nuvem, o TURN garante que uma conexão possa ser estabelecida mesmo quando um ou mais pares não conseguem uma conexão direta. peer-to-peer Para obter mais informações, consulte [Uma API REST para acesso aos serviços TURN](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00).

 Você pode invocar essa API para estabelecer um mecanismo de fallback caso algum dos pares não consiga estabelecer uma peer-to-peer conexão direta por meio de um canal de sinalização. Você deve especificar o Amazon Resource Name (ARN) do seu canal de sinalização para invocar essa API.

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

```
POST /v1/get-ice-server-config HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "{{string}}",
   "ClientId": "{{string}}",
   "Service": "{{string}}",
   "Username": "{{string}}"
}
```

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

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

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

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

 ** [ChannelARN](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ChannelARN"></a>
O ARN do canal de sinalização a ser usado para a peer-to-peer conexão entre os pares configurados.   
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

 ** [ClientId](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ClientId"></a>
Identificador exclusivo para o espectador. Deve ser exclusivo dentro do canal de sinalização.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z0-9_.-]+`   
Obrigatório: não

 ** [Service](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Service"></a>
Especifica o serviço desejado. Atualmente, `TURN` é o único valor válido.  
Tipo: string  
Valores válidos: `TURN`   
Obrigatório: não

 ** [Username](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Username"></a>
Uma ID de usuário opcional a ser associada às credenciais.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z0-9_.-]+`   
Obrigatório: Não

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

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

{
   "IceServerList": [ 
      { 
         "Password": "string",
         "Ttl": number,
         "Uris": [ "string" ],
         "Username": "string"
      }
   ]
}
```

## Elementos de resposta
<a name="API_signaling_GetIceServerConfig_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.

 ** [IceServerList](#API_signaling_GetIceServerConfig_ResponseSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-response-IceServerList"></a>
A lista de objetos de informações do servidor ICE.  
Tipo: matriz de objetos [IceServer](API_signaling_IceServer.md)

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

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

 ** ClientLimitExceededException **   
Sua solicitação foi limitada 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

 ** InvalidClientException **   
O cliente especificado é inválido.  
Código de status HTTP: 400

 ** NotAuthorizedException **   
O chamador não está autorizado a realizar essa operação.  
Código de status HTTP: 401

 ** ResourceNotFoundException **   
O recurso especificado não foi encontrado.  
Código de status HTTP: 404

 ** SessionExpiredException **   
Se a sessão do cliente expirar. Depois que o cliente estiver conectado, a sessão será válida por 45 minutos. O cliente deve se reconectar ao canal para continuar enviando/recebendo mensagens.  
Código de Status HTTP: 400

## Consulte também
<a name="API_signaling_GetIceServerConfig_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/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig)