Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
GetIceServerConfig
Nota: prima di utilizzare questa API, è necessario chiamare l'GetSignalingChannelEndpointAPI per richiedere l'endpoint HTTPS. Quindi specifichi l'endpoint e la regione nella richiesta GetIceServerConfig API.
Ottiene le informazioni sulla configurazione del server ICE (Interactive Connectivity Establishment) URIs, inclusi nome utente e password che possono essere utilizzati per configurare la connessione WebRTC. Il componente ICE utilizza queste informazioni di configurazione per configurare la connessione WebRTC, inclusa l'autenticazione con il relay server Traversal Using Relays around NAT (TURN).
TURN è un protocollo utilizzato per migliorare la connettività delle applicazioni. peer-to-peer Fornendo un servizio di inoltro basato sul cloud, TURN garantisce la possibilità di stabilire una connessione anche quando uno o più peer non sono in grado di effettuare una connessione diretta. peer-to-peer Per ulteriori informazioni, consulta Un'API REST per
Puoi richiamare questa API per stabilire un meccanismo di fallback nel caso in cui uno dei peer non sia in grado di stabilire una peer-to-peer connessione diretta tramite un canale di segnalazione. Devi specificare l'Amazon Resource Name (ARN) del tuo canale di segnalazione per richiamare questa API.
Sintassi della richiesta
POST /v1/get-ice-server-config HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ClientId": "string",
"Service": "string",
"Username": "string"
}Parametri della richiesta URI:
La richiesta non utilizza parametri URI.
Corpo della richiesta
La richiesta accetta i seguenti dati in formato JSON.
- ChannelARN
-
L'ARN del canale di segnalazione da utilizzare per la peer-to-peer connessione tra peer configurati.
Tipo: stringa
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 1024 caratteri.
Modello:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Campo obbligatorio: sì
- ClientId
-
Identificatore univoco per lo spettatore. Deve essere unico all'interno del canale di segnalazione.
Tipo: stringa
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.
Modello:
[a-zA-Z0-9_.-]+Campo obbligatorio: no
- Service
-
Specifica il servizio desiderato. Attualmente,
TURNè l'unico valore valido.Tipo: stringa
Valori validi:
TURNCampo obbligatorio: no
- Username
-
Un ID utente opzionale da associare alle credenziali.
Tipo: stringa
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.
Modello:
[a-zA-Z0-9_.-]+Campo obbligatorio: no
Sintassi della risposta
HTTP/1.1 200
Content-type: application/json
{
"IceServerList": [
{
"Password": "string",
"Ttl": number,
"Uris": [ "string" ],
"Username": "string"
}
]
}Elementi di risposta
Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.
I dati seguenti vengono restituiti in formato JSON mediante il servizio.
- IceServerList
-
L'elenco degli oggetti informativi del server ICE.
Tipo: matrice di oggetti IceServer
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.
- ClientLimitExceededException
-
La tua richiesta è stata limitata perché hai superato il limite di chiamate client consentite. Prova a effettuare la chiamata più tardi.
Codice di stato HTTP: 400
- InvalidArgumentException
-
Il valore di questo parametro di input non è valido.
Codice di stato HTTP: 400
- InvalidClientException
-
Il client specificato non è valido.
Codice di stato HTTP: 400
- NotAuthorizedException
-
Il chiamante non è autorizzato a eseguire questa operazione.
Codice di stato HTTP: 401
- ResourceNotFoundException
-
La risorsa specificata non è stata trovata.
Codice di stato HTTP: 404
- SessionExpiredException
-
Se la sessione del client è scaduta. Una volta connesso il client, la sessione è valida per 45 minuti. Il client deve riconnettersi al canale per continuare a inviare/ricevere messaggi.
Codice di stato HTTP: 400
Vedi anche
Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue AWS SDKs specifiche, consulta quanto segue:
