GetIceServerConfig - Amazon Kinesis Video Streams
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

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

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, einschließlich URIs, 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.

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

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

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

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ChannelARN

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

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

Gibt den gewünschten Dienst an. Derzeit TURN ist dies der einzig gültige Wert.

Typ: Zeichenfolge

Zulässige Werte: TURN

Erforderlich: Nein

Username

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

HTTP/1.1 200
Content-type: application/json

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

Antwortelemente

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

Die Liste der ICE-Serverinformationsobjekte.

Typ: Array von IceServer-Objekten

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

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 Status Code: 400

InvalidArgumentException

Der Wert für diesen Eingabeparameter ist ungültig.

HTTP Status Code: 400

InvalidClientException

Der angegebene Client ist ungültig.

HTTP Status Code: 400

NotAuthorizedException

Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.

HTTP-Statuscode: 401

ResourceNotFoundException

Die angegebene Ressource wurde nicht gefunden.

HTTP Status Code: 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 Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: