GetSignalingChannelEndpoint - Amazon Kinesis Video Streams

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à.

GetSignalingChannelEndpoint

Fornisce un endpoint per il canale di segnalazione specificato per inviare e ricevere messaggi. Questa API utilizza ilSingleMasterChannelEndpointConfigurationparametro di input, che includeProtocolseRoleproprietà.

Protocolsè usato per determinare il meccanismo di comunicazione. Ad esempio, se specifichiWSScome protocollo, questa API produce un endpoint websocket sicuro. Se si specificaHTTPScome protocollo, questa API genera un endpoint HTTPS.

Roledetermina le autorizzazioni di messaggistica. UNMASTERruolo risulta che questa API genera un endpoint che un client può utilizzare per comunicare con uno qualsiasi degli spettatori sul canale. UNVIEWERruolo risulta in questa API che genera un endpoint che un client può utilizzare per comunicare solo con unMASTER.

Sintassi della richiesta

POST /getSignalingChannelEndpoint HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "SingleMasterChannelEndpointConfiguration": { "Protocols": [ "string" ], "Role": "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'Amazon Resource Name (ARN) del canale di segnalamento per il quale vuoi ottenere l'endpoint.

Type: Stringa

Vincoli 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ì

SingleMasterChannelEndpointConfiguration

Una struttura contenente la configurazione dell'endpoint perSINGLE_MASTERtipo di canale.

Tipo: SingleMasterChannelEndpointConfiguration oggetto

Campo obbligatorio: No

Sintassi della risposta

HTTP/1.1 200 Content-type: application/json { "ResourceEndpointList": [ { "Protocol": "string", "ResourceEndpoint": "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.

ResourceEndpointList

Un elenco di endpoint per il canale di segnalazione specificato.

Type: L'array diResourceEndpointListItemoggetti

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

AccessDeniedException

Non disponi delle autorizzazioni necessarie per eseguire questa operazione.

Codice di stato HTTP: 401

ClientLimitExceededException

Kinesis Video Streams ha limitato la richiesta perché hai superato il limite delle 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

ResourceInUseException

La risorsa attualmente non è disponibile per questa operazione. Non è possibile creare nuove risorse con lo stesso nome delle risorse esistenti. Inoltre, le risorse non possono essere aggiornate o eliminate a meno che non si trovino in unACTIVEstato.

Se viene restituita questa eccezione, non utilizzarla per determinare se la risorsa richiesta esiste già. Invece, si consiglia di utilizzare l'API di descrizione specifica delle risorse, ad esempioDescribeStreamper flussi video.

Codice di stato HTTP: 400

ResourceNotFoundException

Amazon Kinesis Video Streams non riesce a trovare lo stream specificato.

Codice di stato HTTP: 404

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue: