Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
GetIceServerConfig
Remarque : Avant d'utiliser cette API, vous devez appeler l'GetSignalingChannelEndpointAPI pour demander le point de terminaison HTTPS. Vous spécifiez ensuite le point de terminaison et la région dans votre demande d'GetIceServerConfigAPI.
Obtient les informations de configuration du serveur ICE (Interactive Connectivity Establishment), notamment les URI, le nom d'utilisateur et le mot de passe qui peuvent être utilisés pour configurer la connexion WebRTC. Le composant ICE utilise ces informations de configuration pour configurer la connexion WebRTC, notamment pour s'authentifier auprès du serveur relais Traversal Using Relays around NAT (TURN).
TURN est un protocole utilisé pour améliorer la connectivité des peer-to-peer applications. En fournissant un service de relais basé sur le cloud, TURN garantit qu'une connexion peut être établie même lorsqu'un ou plusieurs pairs sont incapables d'établir une peer-to-peer connexion directe. Pour plus d'informations, consultez Une API REST pour accéder aux services TURN
Vous pouvez invoquer cette API pour établir un mécanisme de secours au cas où l'un des pairs ne parviendrait pas à établir une peer-to-peer connexion directe via un canal de signalisation. Vous devez spécifier l'Amazon Resource Name (ARN) de votre canal de signalisation afin d'appeler cette API.
Syntaxe de la demande
POST /v1/get-ice-server-config HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ClientId": "string",
"Service": "string",
"Username": "string"
}Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
Corps de la demande
Cette demande accepte les données suivantes au format JSON.
- ChannelARN
-
L'ARN du canal de signalisation à utiliser pour la peer-to-peer connexion entre les homologues configurés.
Type : chaîne
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.
Modèle :
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Obligatoire : oui
- ClientId
-
Identifiant unique pour le spectateur. Doit être unique dans le canal de signalisation.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
[a-zA-Z0-9_.-]+Obligatoire : non
- Service
-
Spécifie le service souhaité. Actuellement,
TURNest la seule valeur valide.Type : chaîne
Valeurs valides :
TURNObligatoire : non
- Username
-
Un ID utilisateur facultatif à associer aux informations d'identification.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
[a-zA-Z0-9_.-]+Obligatoire : non
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"IceServerList": [
{
"Password": "string",
"Ttl": number,
"Uris": [ "string" ],
"Username": "string"
}
]
}Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
- IceServerList
-
Liste des objets d'information du serveur ICE.
Type : tableau d’objets IceServer
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- ClientLimitExceededException
-
Votre demande a été limitée car vous avez dépassé la limite d'appels clients autorisés. Essayez de passer l'appel plus tard.
Code d’état HTTP : 400
- InvalidArgumentException
-
La valeur de ce paramètre d'entrée n'est pas valide.
Code d’état HTTP : 400
- InvalidClientException
-
Le client spécifié n'est pas valide.
Code d’état HTTP : 400
- NotAuthorizedException
-
L'appelant n'est pas autorisé à effectuer cette opération.
Code d'état HTTP : 401
- ResourceNotFoundException
-
La ressource spécifiée est introuvable.
Code d’état HTTP : 404
- SessionExpiredException
-
Si la session client est expirée. Une fois le client connecté, la session est valide pendant 45 minutes. Le client doit se reconnecter au canal pour continuer à envoyer/recevoir des messages.
Code d’état HTTP : 400
consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :
