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

GetSignalingChannelEndpoint

Stellt einen Endpunkt für den angegebenen Signalkanal zum Senden und Empfangen von Nachrichten bereit. Diese API verwendet den SingleMasterChannelEndpointConfiguration Eingabeparameter, der aus den Role Eigenschaften Protocols und besteht.

Protocolswird verwendet, um den Kommunikationsmechanismus zu bestimmen. Wenn Sie beispielsweise WSS als Protokoll angeben, erzeugt diese API einen sicheren Websocket-Endpunkt. Wenn Sie HTTPS als Protokoll angeben, generiert diese API einen HTTPS-Endpunkt. Wenn Sie WEBRTC als Protokoll angeben, der Signalkanal jedoch nicht für die Aufnahme konfiguriert ist, erhalten Sie den Fehler. InvalidArgumentException

Rolebestimmt die Messaging-Berechtigungen. Eine MASTER Rolle führt dazu, dass diese API einen Endpunkt generiert, über den ein Client mit allen Zuschauern auf dem Kanal kommunizieren kann. Eine VIEWER Rolle führt dazu, dass diese API einen Endpunkt generiert, über den ein Client nur mit einem kommunizieren kannMASTER.

Anforderungssyntax

POST /getSignalingChannelEndpoint HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "SingleMasterChannelEndpointConfiguration": { 
      "Protocols": [ "string" ],
      "Role": "string"
   }
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ChannelARN

Der Amazon-Ressourcenname (ARN) des Signalisierungskanals, für den Sie einen Endpunkt abrufen möchten.

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

SingleMasterChannelEndpointConfiguration

Eine Struktur, die die Endpunktkonfiguration für den SINGLE_MASTER Kanaltyp enthält.

Typ: SingleMasterChannelEndpointConfiguration Objekt

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "ResourceEndpointList": [ 
      { 
         "Protocol": "string",
         "ResourceEndpoint": "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.

ResourceEndpointList

Eine Liste von Endpunkten für den angegebenen Signalkanal.

Typ: Array von ResourceEndpointListItem-Objekten

Fehler

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

AccessDeniedException

Sie verfügen nicht über die erforderlichen Berechtigungen, um diesen Vorgang auszuführen.

HTTP-Statuscode: 401

ClientLimitExceededException

Kinesis Video Streams hat die Anfrage 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

ResourceInUseException

Wenn der Eingang StreamARN oder ChannelARN Eingang bereits einer anderen Kinesis Video Stream-Ressource zugeordnet CLOUD_STORAGE_MODE ist oder wenn sich der angegebene Eingang StreamARN oder Eingang nicht im Status Aktiv ChannelARN befindet, versuchen Sie es mit einer der folgenden Methoden:

  1. Die DescribeMediaStorageConfiguration API, um zu ermitteln, welchem Stream der angegebene Kanal zugeordnet ist.

  2. Die DescribeMappedResourceConfiguration API zur Bestimmung des Kanals, dem der angegebene Stream zugeordnet ist.

  3. Die DescribeStream oder DescribeSignalingChannel API zur Bestimmung des Status der Ressource.

HTTP Status Code: 400

ResourceNotFoundException

Amazon Kinesis Video Streams kann den von Ihnen angegebenen Stream nicht finden.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

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