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

ListSignalingChannels

Gibt ein Array von ChannelInfo Objekten zurück. Jedes Objekt beschreibt einen Signalkanal. Um nur die Kanäle abzurufen, die eine bestimmte Bedingung erfüllen, können Sie a angebenChannelNameCondition.

Anforderungssyntax

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

{
   "ChannelNameCondition": { 
      "ComparisonOperator": "string",
      "ComparisonValue": "string"
   },
   "MaxResults": number,
   "NextToken": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ChannelNameCondition

Optional: Gibt nur die Kanäle zurück, die eine bestimmte Bedingung erfüllen.

Typ: ChannelNameCondition Objekt

Required: No

MaxResults

Die maximale Anzahl von Kanälen, die in der Antwort zurückgegeben werden sollen. Die Standardeinstellung ist 500.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximaler Wert von 10000.

Required: No

NextToken

Wenn Sie diesen Parameter angeben und das Ergebnis einer ListSignalingChannels Operation gekürzt wird, gibt der Aufruf das NextToken in der Antwort zurück. Um einen weiteren Stapel von Kanälen zu erhalten, geben Sie dieses Token in Ihrer nächsten Anfrage an.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 512.

Pattern: [a-zA-Z0-9+/=]*

Required: No

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "ChannelInfoList": [ 
      { 
         "ChannelARN": "string",
         "ChannelName": "string",
         "ChannelStatus": "string",
         "ChannelType": "string",
         "CreationTime": number,
         "SingleMasterConfiguration": { 
            "MessageTtlSeconds": number
         },
         "Version": "string"
      }
   ],
   "NextToken": "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.

ChannelInfoList

Ein Array von ChannelInfo-Objekten.

Typ: Array von ChannelInfo-Objekten

NextToken

Wenn die Antwort gekürzt wird, gibt der Aufruf dieses Element mit einem Token zurück. Verwenden Sie dieses Token in Ihrer nächsten Anfrage, um den nächsten Stapel von Streams abzurufen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 512.

Pattern: [a-zA-Z0-9+/=]*

Fehler

Informationen zu den Fehlern, die allen Aktionen gemeinsam sind, finden Sie unterHä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

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: