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 il parametro SingleMasterChannelEndpointConfiguration
di input, che consiste nelle proprietà Protocols
eRole
.
Protocols
viene utilizzato per determinare il meccanismo di comunicazione. Ad esempio, se si specifica WSS
come protocollo, questa API produce un endpoint websocket sicuro. Se si specifica HTTPS
come protocollo, questa API genera un endpoint HTTPS. Se lo specifichi WEBRTC
come protocollo, ma il canale di segnalazione non è configurato per l'ingestione, riceverai l'errore. InvalidArgumentException
Role
determina le autorizzazioni di messaggistica. Un MASTER
ruolo fa sì che questa API generi un endpoint che un client può utilizzare per comunicare con qualsiasi spettatore del canale. Un VIEWER
ruolo fa sì che questa API generi un endpoint che un client può utilizzare per comunicare solo con un. MASTER
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 segnalazione per il quale desideri ottenere un endpoint.
▬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ì
- SingleMasterChannelEndpointConfiguration
-
Una struttura contenente la configurazione dell'endpoint per il tipo di canale.
SINGLE_MASTER
Tipo: oggetto SingleMasterChannelEndpointConfiguration
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.
Tipo: matrice di oggetti ResourceEndpointListItem
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.
- AccessDeniedException
-
Non hai le autorizzazioni necessarie per eseguire questa operazione.
Codice di stato HTTP: 401
- ClientLimitExceededException
-
Kinesis Video Streams ha limitato la richiesta perché è stato 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
- ResourceInUseException
-
Quando l'ingresso
StreamARN
oChannelARN
l'ingressoCLOUD_STORAGE_MODE
sono già mappati su un'altra risorsa Kinesis Video Stream, o se l'StreamARN
ingresso fornitoChannelARN
o non è nello stato Attivo, prova una delle seguenti soluzioni:-
L'
DescribeMediaStorageConfiguration
API per determinare a cosa è mappato lo stream di un determinato canale. -
L'
DescribeMappedResourceConfiguration
API per determinare il canale su cui è mappato lo stream specificato. -
L'
DescribeStream
o l'DescribeSignalingChannel
API per determinare lo stato della risorsa.
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 AWS SDK specifici della lingua, consulta quanto segue: