Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

 **Nota:** Antes de usar esta API, debes llamar a la `GetSignalingChannelEndpoint` API para solicitar el punto final HTTPS. A continuación, especificas el punto final y la región en tu solicitud de `GetIceServerConfig` API.

Obtiene la información de configuración del servidor del Interactive Connectivity Establishment (ICE) URIs, incluidos el nombre de usuario y la contraseña que se pueden utilizar para configurar la conexión WebRTC. El componente ICE utiliza esta información de configuración para configurar la conexión WebRTC, incluida la autenticación con el servidor de retransmisión Traversal Using Relays around NAT (TURN). 

TURN es un protocolo que se utiliza para mejorar la conectividad de las aplicaciones. peer-to-peer Al proporcionar un servicio de retransmisión basado en la nube, TURN garantiza que se pueda establecer una conexión incluso cuando uno o más pares no puedan establecer una peer-to-peer conexión directa. Para obtener más información, consulte [una API REST para acceder a los servicios de TURN](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00).

 Puede invocar esta API para establecer un mecanismo alternativo en caso de que alguno de los pares no pueda establecer una peer-to-peer conexión directa a través de un canal de señalización. Debe especificar el nombre de recurso de Amazon (ARN) de su canal de señalización para poder invocar esta API.

## Sintaxis de la solicitud
<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 de solicitud del URI
<a name="API_signaling_GetIceServerConfig_RequestParameters"></a>

La solicitud no utiliza ningún parámetro de URI.

## Cuerpo de la solicitud
<a name="API_signaling_GetIceServerConfig_RequestBody"></a>

La solicitud acepta los siguientes datos en formato JSON.

 ** [ChannelARN](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ChannelARN"></a>
El ARN del canal de señalización que se utilizará para la peer-to-peer conexión entre pares configurados.   
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.  
Patrón: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Obligatorio: sí

 ** [ClientId](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ClientId"></a>
Identificador único para el espectador. Debe ser único dentro del canal de señalización.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.  
Patrón: `[a-zA-Z0-9_.-]+`   
Obligatorio: no

 ** [Service](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Service"></a>
Especifica el servicio deseado. Actualmente, `TURN` es el único valor válido.  
Tipo: cadena  
Valores válidos: `TURN`   
Obligatorio: no

 ** [Username](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Username"></a>
Un seudónimo opcional que se asociará a las credenciales.  
Tipo: cadena  
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.  
Patrón: `[a-zA-Z0-9_.-]+`   
Obligatorio: no

## Sintaxis de la respuesta
<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 respuesta
<a name="API_signaling_GetIceServerConfig_ResponseElements"></a>

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

 ** [IceServerList](#API_signaling_GetIceServerConfig_ResponseSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-response-IceServerList"></a>
La lista de objetos de información del servidor ICE.  
Tipo: matriz de objetos [IceServer](API_signaling_IceServer.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Tipos de errores comunes](CommonErrors.md).

 ** ClientLimitExceededException **   
Su solicitud se ha limitado porque ha superado el límite de llamadas de clientes permitidas. Intenta hacer la llamada más tarde.  
Código de estado HTTP: 400

 ** InvalidArgumentException **   
El valor de este parámetro de entrada no es válido.  
Código de estado HTTP: 400

 ** InvalidClientException **   
El cliente especificado no es válido.  
Código de estado HTTP: 400

 ** NotAuthorizedException **   
La persona que llama no está autorizada a realizar esta operación.  
Código de estado HTTP: 401

 ** ResourceNotFoundException **   
No se encuentra el recurso especificado.  
Código de estado HTTP: 404

 ** SessionExpiredException **   
Si la sesión del cliente ha caducado. Una vez que el cliente está conectado, la sesión es válida durante 45 minutos. El cliente debe volver a conectarse al canal para seguir enviando/recibiendo mensajes.  
Código de estado HTTP: 400

## Véase también
<a name="API_signaling_GetIceServerConfig_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas AWS SDKs específicos, consulta lo siguiente:
+  [AWS Interfaz de línea de comandos 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)