Suche nach Channels mit der Channels-API

In diesem Thema wird erklärt, wie Sie mithilfe der Channels-API nach Cloud Playout-Kanälen suchen können.

Einleitung

Wenn Sie viele Cloud Playout-Kanäle erstellen, werden Sie es wahrscheinlich nützlich finden, nach den Kanälen zu suchen, an denen Sie gerade arbeiten möchten. Cloud Playout bietet einen robusten Mechanismus für die Suche nach Kanälen, entweder mit dem Studio-Modul oder mit der Channels-API.

Dieses Thema behandelt die Suche nach Channels mithilfe der Channels-API.

Suchparameter

Die Kanalsuche verwendet einen Parameter (q) , der der GET CHANNELS-Anfrage hinzugefügt wird:

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

Die allgemeine Form des Parameters q mit einem Wert ist:

q=search_text advanced_search

Die Komponenten der Suchanfrage sind wie folgt

  • search_text- die Wörter, nach denen im Namen, der Beschreibung oder der ID des Kanals gesucht werden soll
  • advanced_search- eine Reihe von Filtern, die die Suche einschränken

search_text Sowohl die Filter als auch die advanced_search Filter sind optional.

Beispiel

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

Erweiterte Suchmuster

Der advanced_search-Teil der Abfrage ist eine Kombination von Mustern, die durch ein Leerzeichen getrennt sind. Muster, die nicht mit den akzeptierten Mustern übereinstimmen, führen zu einer Fehlermeldung. Die folgende Tabelle zeigt die unterstützten Muster.

Erweiterte Suchmuster
Pattern Name Beschreibung Accepted Values
state um Kanäle auf der Grundlage ihres Zustands zu filtern. Dieses Muster akzeptiert mehrere Werte & die Werte sollten immer zwischen eckigen Klammern - [] - eingeschlossen werden, auch für einen einzelnen Wert. Dies ist ein OR-Fall. Die API holt Kanäle, die einem der angegebenen Zustände entsprechen. state:[draft,running,create_error] oder
state:[running,stopping] oder
state:[starting]
region um Kanäle auf der Grundlage ihrer Region zu filtern. Dieses Muster akzeptiert mehrere Werte & die Werte sollten immer zwischen eckigen Klammern - [] - eingeschlossen werden, auch für einen einzelnen Wert. Dies ist ein OR-Fall. Die API holt Kanäle, die einer der angegebenen Regionen entsprechen. region:[us-east-1,us-east-2,us-west-2] oder
region:[eu-west-1,eu-west-2] oder
region:[us-west-2]
live zum Filtern von Kanälen mit Live-Eingang live:true/false
loop um geloopte/nicht geloopte Kanäle zu filtern. loop:true/false
dynamicOverlays um Kanäle mit dynamischen Überlagerungen zu filtern dynamicOverlays:true/false
output zum Filtern auf der Grundlage der Kanalausgänge. Akzeptiert mehrere Werte und die Werte sollten immer zwischen eckigen Klammern - [] - eingeschlossen werden, auch für einen einzelnen Wert. Allerdings sind nur die Werte rtmp, rtp und s3 akzeptiert. Dies ist ein AND-Fall. Wenn rtmp & s3 gewählt wird, filtert die API Kanäle mit beiden rtmp & s3 als Ausgänge. output:[rtmp,s3] oder
output:[rtp,s3] oder
output:[rtmp]
name um auf der Grundlage eines im Kanalnamen enthaltenen Begriffs zu filtern. Wenn der Name Leerzeichen enthält, sollte er in einfache/doppelte Anführungszeichen eingeschlossen werden. name:nature oder
name:'nature stories' oder
name:"nature videos"
desc um auf der Grundlage eines in der Kanalbeschreibung enthaltenen Begriffs zu filtern. Wenn der Wert Leerzeichen enthält, sollte er in einfache/doppelte Anführungszeichen eingeschlossen werden. desc:nature oder
desc:'nature stories' oder
desc:"nature videos 'amateur'"
id zum Filtern nach der öffentlichen Kanal-ID id:67ytd89 oder id:252748cef5de464e8e8f87b7e15e7d34
startTime um nach dem Startzeitbereich des Kanals zu filtern. Sowohl das Datum als auch das Datum bis zum Datum sind durch .. und das akzeptierte Datums- und Uhrzeitformat getrennt yyyy-mm-dd hh:mm:ss. Eine Zeitzonenverschiebung wird ebenfalls akzeptiert und ist optional. Wenn keine Angabe gemacht wird, wird der Wert als UTC-Datumszeit betrachtet. Es wird nur das 24-Stunden-Format akzeptiert. startTime:2021-10-29 05:57:10..2021-10-30 05:57:10
startTime:..2021-10-30 05:57:10 oder
startTime:2021-10-30 05:57:10.. oder
startTime:2021-10-29 05:57:10 +09:30..2021-10-30 05:57:10 +09:30
createTime um nach dem Zeitbereich der Kanalerstellung zu filtern. Sowohl das Datum als auch das Datum bis zum Datum sind durch .. und das akzeptierte Datums- und Uhrzeitformat getrennt yyyy-mm-dd hh:mm:ss. Eine Zeitzonenverschiebung wird ebenfalls akzeptiert und ist optional. Wenn keine Angabe gemacht wird, wird der Wert als UTC-Datumszeit betrachtet. Es wird nur das 24-Stunden-Format akzeptiert. createTime:2021-10-29 05:57:10..2021-10-30 05:57:10
createTime:..2021-10-30 05:57:10 oder
createTime:2021-10-30 05:57:10.. oder
createTime:2021-10-29 05:57:10 +09:30..2021-10-30 05:57:10 +09:30

Beispiele

Nachstehend finden Sie ein Beispiel für eine Abfrage:

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

Hier wird der Suchtext sein hello world 'in this world' Und advanced_search wird loop:true live:true startTime:..2021-12-11 10:30:00 state:[draft,running] output:[rtmp,s3]

Einige weitere Beispiele:

Beispiele für die Suche
suche_text erweiterte_Suche kommentare
hello "world is (leer) Nur der search_text wird nach id, name und description durchsucht
(leer) loop:true name:cloud Nur Kanäle, die den Filtern entsprechen, werden zurückgegeben
ced52df ad:true region[us-east-1,us-west-2] Die Ergebnisse enthalten Kanäle, in denen "ced52df" in der ID, dem Namen oder der Beschreibung enthalten ist UND die Kanäle den Filtern entsprechen