ListSignalingChannels - Amazon Kinesis Video Streams
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

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.

ListSignalingChannels

Renvoie un tableau d'ChannelInfoobjets. Chaque objet décrit un canal de signalisation. Pour récupérer uniquement les canaux qui répondent à une condition spécifique, vous pouvez spécifier unChannelNameCondition.

Syntaxe de la demande

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

{
   "ChannelNameCondition": { 
      "ComparisonOperator": "string",
      "ComparisonValue": "string"
   },
   "MaxResults": number,
   "NextToken": "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.

ChannelNameCondition

Facultatif : renvoie uniquement les canaux qui répondent à une condition spécifique.

Type : objet ChannelNameCondition

Obligatoire : non

MaxResults

Le nombre maximum de canaux à renvoyer dans la réponse. La valeur par défaut est 500.

Type : entier

Plage valide : Valeur minimum de 1. Valeur maximum de 10 000.

Obligatoire : non

NextToken

Si vous spécifiez ce paramètre, lorsque le résultat d'une ListSignalingChannels opération est tronqué, l'appel renvoie le NextToken dans la réponse. Pour obtenir un autre lot de chaînes, fournissez ce jeton dans votre prochaine demande.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximale de 512.

Modèle : [a-zA-Z0-9+/=]*

Obligatoire : non

Syntaxe de la réponse

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"
}

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.

ChannelInfoList

Tableau d’objets ChannelInfo.

Type : tableau d’objets ChannelInfo

NextToken

Si la réponse est tronquée, l'appel renvoie cet élément avec un jeton. Pour obtenir le prochain lot de streams, utilisez ce jeton dans votre prochaine demande.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximale de 512.

Modèle : [a-zA-Z0-9+/=]*

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Vous ne disposez pas des autorisations requises pour effectuer cette opération.

Code d'état HTTP : 401

ClientLimitExceededException

Kinesis Video Streams a limité la demande car vous avez dépassé le nombre maximal 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

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :