

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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

 **Hinweis:** Bevor Sie diese API verwenden, müssen Sie die `GetSignalingChannelEndpoint` API aufrufen, um den HTTPS-Endpunkt anzufordern. Anschließend geben Sie den Endpunkt und die Region in Ihrer `GetIceServerConfig` API-Anfrage an.

Ruft die ICE-Serverkonfigurationsinformationen (Interactive Connectivity Establishment) ab URIs, einschließlich Benutzername und Kennwort, die zur Konfiguration der WebRTC-Verbindung verwendet werden können. Die ICE-Komponente verwendet diese Konfigurationsinformationen, um die WebRTC-Verbindung einzurichten, einschließlich der Authentifizierung beim Relay-Server Traversal Using Relays around NAT (TURN). 

TURN ist ein Protokoll, das zur Verbesserung der Konnektivität von Anwendungen verwendet wird. peer-to-peer Durch die Bereitstellung eines cloudbasierten Relay-Dienstes stellt TURN sicher, dass eine Verbindung auch dann hergestellt werden kann, wenn ein oder mehrere Peers keine direkte peer-to-peer Verbindung herstellen können. Weitere Informationen finden Sie unter [Eine REST-API für den Zugriff auf TURN-Dienste](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00).

 Sie können diese API aufrufen, um einen Fallback-Mechanismus einzurichten, falls einer der Peers keine direkte peer-to-peer Verbindung über einen Signalkanal herstellen kann. Sie müssen den Amazon-Ressourcennamen (ARN) Ihres Signalisierungskanals angeben, um diese API aufzurufen.

## Anforderungssyntax
<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}}"
}
```

## URI-Anfrageparameter
<a name="API_signaling_GetIceServerConfig_RequestParameters"></a>

Die Anforderung verwendet keine URI-Parameter.

## Anforderungstext
<a name="API_signaling_GetIceServerConfig_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [ChannelARN](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ChannelARN"></a>
Der ARN des Signalkanals, der für die peer-to-peer Verbindung zwischen konfigurierten Peers verwendet werden soll.   
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Erforderlich: Ja

 ** [ClientId](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-ClientId"></a>
Eindeutiger Bezeichner für den Betrachter. Muss innerhalb des Signalkanals eindeutig sein.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.  
Pattern: `[a-zA-Z0-9_.-]+`   
Erforderlich: Nein

 ** [Service](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Service"></a>
Gibt den gewünschten Dienst an. Derzeit `TURN` ist dies der einzig gültige Wert.  
Typ: Zeichenfolge  
Zulässige Werte: `TURN`   
Erforderlich: Nein

 ** [Username](#API_signaling_GetIceServerConfig_RequestSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-request-Username"></a>
Eine optionale Benutzer-ID, die den Anmeldeinformationen zugeordnet werden soll.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.  
Pattern: `[a-zA-Z0-9_.-]+`   
Erforderlich: Nein

## Antwortsyntax
<a name="API_signaling_GetIceServerConfig_ResponseSyntax"></a>

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

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

## Antwortelemente
<a name="API_signaling_GetIceServerConfig_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

 ** [IceServerList](#API_signaling_GetIceServerConfig_ResponseSyntax) **   <a name="KinesisVideo-signaling_GetIceServerConfig-response-IceServerList"></a>
Die Liste der ICE-Serverinformationsobjekte.  
Typ: Array von [IceServer](API_signaling_IceServer.md)-Objekten

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

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehlertypen](CommonErrors.md).

 ** ClientLimitExceededException **   
Ihre Anfrage wurde gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.  
HTTP-Statuscode: 400

 ** InvalidArgumentException **   
Der Wert für diesen Eingabeparameter ist ungültig.  
HTTP-Statuscode: 400

 ** InvalidClientException **   
Der angegebene Client ist ungültig.  
HTTP-Statuscode: 400

 ** NotAuthorizedException **   
Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.  
HTTP-Statuscode: 401

 ** ResourceNotFoundException **   
Die angegebene Ressource wurde nicht gefunden.  
HTTP-Statuscode: 404

 ** SessionExpiredException **   
Wenn die Clientsitzung abgelaufen ist. Sobald der Client verbunden ist, ist die Sitzung 45 Minuten lang gültig. Der Client sollte sich erneut mit dem Kanal verbinden, um weiterhin Nachrichten senden/empfangen zu können.  
HTTP-Statuscode: 400

## Weitere Informationen finden Sie unter:
<a name="API_signaling_GetIceServerConfig_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) 