Recherche de chaînes à l'aide de l'API des chaînes

Cette rubrique explique comment rechercher des canaux Cloud Playout à l'aide de l'API Channels.

Introduction

Si vous créez de nombreux canaux Cloud Playout, il vous sera probablement utile de rechercher celui ou ceux sur lesquels vous souhaitez travailler à ce moment-là. Cloud Playout fournit un mécanisme robuste de recherche de chaînes à l'aide du module Studio ou de l'API Channels.

Cette rubrique traite de la recherche de chaînes à l'aide de l'API Channels.

Paramètre de recherche

La recherche de chaînes utilise un paramètre (q) qui est ajouté à la requête GET CHANNELS :

https://cm.cloudplayout.brightcove.com/accounts/{account_id}/cp_channels

La forme générale du paramètre q avec une valeur est :

q=search_text advanced_search

Les éléments de la requête de recherche sont les suivants :

  • search_text- le ou les mots à rechercher dans le nom, la description ou l'identifiant de la chaîne
  • advanced_search- un ensemble de filtres qui affinent la recherche

Les advanced_search filtres search_text et sont tous deux facultatifs.

Exemple

...?q=nature stories loop:true desc:"nature stories" startTime:2021-12-11 10:30:00..2021-12-12 12:23:00

Modèles de recherche avancée

La partie advanced_search de la requête est une combinaison de motifs séparés par un espace. Les motifs qui ne correspondent pas à ceux qui sont acceptés entraîneront un retour d'erreur. Le tableau ci-dessous présente les modèles pris en charge.

Modèles de recherche avancée
Pattern Name Description Accepted Values
state pour filtrer les canaux en fonction de leur état. Ce modèle accepte plusieurs valeurs & . Les valeurs doivent toujours être placées entre crochets - [] - même pour une seule valeur. Il s'agit d'un cas de bloc opératoire. L'API récupérera les chaînes correspondant à l'un des états donnés. state:[draft,running,create_error] ou
state:[running,stopping] ou
state:[starting]
region pour filtrer les chaînes en fonction de leur région. Ce modèle accepte plusieurs valeurs & . Les valeurs doivent toujours être placées entre crochets - [] - même pour une seule valeur. Il s'agit d'un cas de bloc opératoire. L'API récupère les chaînes correspondant à l'une des régions données. region:[us-east-1,us-east-2,us-west-2] ou
region:[eu-west-1,eu-west-2] ou
region:[us-west-2]
live pour filtrer les canaux avec entrée en direct live:true/false
loop pour filtrer les canaux bouclés/non bouclés. loop:true/false
dynamicOverlays pour filtrer les canaux avec des superpositions dynamiques dynamicOverlays:true/false
output pour filtrer en fonction des sorties des canaux. Accepte plusieurs valeurs et les valeurs doivent toujours être placées entre crochets - [] - même pour une seule valeur. Les seules valeurs acceptées sont rtmp, rtp & s3. Il s'agit d'un cas ET. Si rtmp & s3 est choisi, l'API filtrera les canaux dont les sorties sont à la fois rtmp & s3. output:[rtmp,s3] ou
output:[rtp,s3] ou
output:[rtmp]
name pour filtrer sur la base d'un terme contenu dans le nom du canal. Lorsque le nom contient des espaces, il doit être placé entre guillemets simples ou doubles. name:nature ou
name:'nature stories' ou
name:"nature videos"
desc pour filtrer sur la base d'un terme contenu dans la description du canal. Lorsque la valeur contient des espaces, elle doit être placée entre guillemets simples ou doubles. desc:nature ou
desc:'nature stories' ou
desc:"nature videos 'amateur'"
id pour filtrer sur la base de l'identifiant public du canal id:67ytd89 ou id:252748cef5de464e8e8f87b7e15e7d34
startTime pour filtrer en fonction de l'heure de début du canal. Les dates de début et de fin sont séparées par .. et le format de date et d'heure accepté est yyyy-mm-dd hh:mm:ss. Un décalage de fuseau horaire est également accepté et est facultatif. Si elle n'est pas fournie, la valeur sera considérée comme la date et l'heure UTC. Seul le format 24 heures est accepté. startTime:2021-10-29 05:57:10..2021-10-30 05:57:10
startTime:..2021-10-30 05:57:10 ou
startTime:2021-10-30 05:57:10.. ou
startTime:2021-10-29 05:57:10 +09:30..2021-10-30 05:57:10 +09:30
createTime pour filtrer en fonction de l'heure de création du canal. Les dates de début et de fin sont séparées par .. et le format de date et d'heure accepté est yyyy-mm-dd hh:mm:ss. Un décalage de fuseau horaire est également accepté et est facultatif. Si elle n'est pas fournie, la valeur sera considérée comme la date et l'heure UTC. Seul le format 24 heures est accepté. createTime:2021-10-29 05:57:10..2021-10-30 05:57:10
createTime:..2021-10-30 05:57:10 ou
createTime:2021-10-30 05:57:10.. ou
createTime:2021-10-29 05:57:10 +09:30..2021-10-30 05:57:10 +09:30

Exemples

Vous trouverez ci-dessous un exemple de requête :

...?q=hello world 'in this world' loop:true live:true startTime:..2021-12-11 10:30:00 state:[draft,running] output:[rtmp,s3]

Ici, le search_text sera hello world 'in this world' et advanced_search sera loop:true live:true startTime:..2021-12-11 10:30:00 state:[draft,running] output:[rtmp,s3]

Quelques exemples supplémentaires :

Exemples de recherche
texte_de_la_recherche recherche_avancée commentaires
hello "world is (vide) Seul le texte de la recherche sera recherché par rapport à l'identifiant, au nom et à la description
(vide) loop:true name:cloud Seuls les canaux correspondant aux filtres seront renvoyés
ced52df ad:true region[us-east-1,us-west-2] Les résultats incluront les chaînes où "ced52df" est contenu dans l'identifiant, le nom ou la description ET les chaînes correspondent aux filtres