Búsqueda de canales mediante la API de canales

Este tema explica cómo buscar canales de Cloud Playout mediante la API de canales.

Introducción

Si crea muchos canales de Cloud Playout, es probable que le resulte útil buscar los canales en los que desea trabajar en este momento. Cloud Playout proporciona un mecanismo sólido para buscar canales mediante el módulo Studio o la API de canales.

Este tema cubre la búsqueda de canales mediante la API de canales.

Parámetro de búsqueda

La búsqueda de canales utiliza un parámetro (q ) que se agrega a la solicitud GET CHANNELS:

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

La forma general del parámetro q con un valor es:

q=search_text advanced_search

Los componentes de la consulta de búsqueda son los siguientes:

  • search_text- la(s) palabra(s) a buscar en nombre, descripción o id del canal
  • advanced_search- un conjunto de filtros que acotan la búsqueda

Ambos search_text y advanced_search los filtros son opcionales.

Ejemplo

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

Patrones de búsqueda avanzada

La parte advanced_search de la consulta es una combinación de patrones separados por un espacio. Los patrones que no coincidan con los aceptados darán como resultado un error. La siguiente tabla muestra los patrones admitidos.

Patrones de búsqueda avanzada
Pattern Name Descripción Accepted Values
state para filtrar canales según su estado. Este patrón acepta múltiples valores. & los valores siempre deben estar encerrados entre corchetes - [] - incluso para un solo valor. Este es un caso de quirófano. La API buscará canales que coincidan con cualquiera de los estados dados. state:[draft,running,create_error] o
state:[running,stopping] o
state:[starting]
region para filtrar canales según su región. Este patrón acepta múltiples valores. & los valores siempre deben estar encerrados entre corchetes - [] - incluso para un solo valor. Este es un caso de quirófano. La API buscará canales que coincidan con cualquiera de las regiones dadas. region:[us-east-1,us-east-2,us-west-2] o
region:[eu-west-1,eu-west-2] o
region:[us-west-2]
live para filtrar canales con entrada en vivo live:true/false
loop para filtrar canales en bucle/sin bucle. loop:true/false
dynamicOverlays para filtrar canales con superposiciones dinámicas dynamicOverlays:true/false
output para filtrar en función de las salidas de los canales. Acepta múltiples valores y los valores siempre deben estar encerrados entre corchetes - [] - incluso para un solo valor. Aunque solo los valores aceptados son rtmp, rtp & s3. Este es un caso AND. Si rtmp & s3 se eligen, entonces la API filtrará los canales con ambos rtmp & s3 como salidas. output:[rtmp,s3] o
output:[rtp,s3] o
output:[rtmp]
name para filtrar según un término contenido en el nombre del canal. Cuando el nombre contiene espacios, debe incluirse entre comillas simples o dobles. name:nature o
name:'nature stories' o
name:"nature videos"
desc para filtrar según un término contenido en la descripción del canal. Cuando el valor contiene espacios, debe incluirse entre comillas simples o dobles. desc:nature o
desc:'nature stories' o
desc:"nature videos 'amateur'"
id para filtrar según la identificación pública del canal id:67ytd89 o id:252748cef5de464e8e8f87b7e15e7d34
startTime para filtrar según el intervalo de tiempo de inicio del canal. Las fechas desde y hasta están separadas por .. y el formato de fecha y hora aceptado es yyyy-mm-dd hh:mm:ss. También se acepta un desplazamiento de zona horaria y es opcional. Cuando no se proporcione, el valor se considerará como fecha y hora UTC. Solo se acepta el formato de 24 horas. startTime:2021-10-29 05:57:10..2021-10-30 05:57:10 o
startTime:..2021-10-30 05:57:10 o
startTime:2021-10-30 05:57:10.. o
startTime:2021-10-29 05:57:10 +09:30..2021-10-30 05:57:10 +09:30
createTime para filtrar según el intervalo de tiempo de creación del canal. Las fechas desde y hasta están separadas por .. y el formato de fecha y hora aceptado es yyyy-mm-dd hh:mm:ss. También se acepta un desplazamiento de zona horaria y es opcional. Cuando no se proporcione, el valor se considerará como fecha y hora UTC. Solo se acepta el formato de 24 horas. createTime:2021-10-29 05:57:10..2021-10-30 05:57:10 o
createTime:..2021-10-30 05:57:10 o
createTime:2021-10-30 05:57:10.. o
createTime:2021-10-29 05:57:10 +09:30..2021-10-30 05:57:10 +09:30

Ejemplos

A continuación se muestra una consulta de muestra:

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

Aquí el search_text será hello world 'in this world' Y advanced_search será loop:true live:true startTime:..2021-12-11 10:30:00 state:[draft,running] output:[rtmp,s3]

Algunos ejemplos más:

Ejemplos de búsqueda
buscar texto Búsqueda Avanzada comentarios
hello "world is (vacío) Solo se buscará el texto_de_búsqueda contra id, nombre y descripción
(vacío) loop:true name:cloud Solo se devolverán los canales que coincidan con los filtros.
ced52df ad:true region[us-east-1,us-west-2] Los resultados incluirán canales donde "ced52df" está contenido en la identificación, el nombre o la descripción Y los canales coinciden con los filtros