取得即時或 VOD 工作清單
簡介
一種GET
要求https://api.bcovlive.io/v1/jobs
Live API的終結點允許您獲取已創建的實時作業的列表。同樣,GET
請求https://api.bcovlive.io/v1/jobs/{job_id}/vods
獲取現場作業的VOD作業列表。有關這些請求的完整詳細信息,請參見API參考。本主題提供了概述和一些其他細節。除非另有說明,否則以下描述的參數適用於這兩個請求。
分頁
分頁結果通過start_token
和page_size
查詢參數。頁面大小指示每個請求要返回的結果數,並且可以設置為1到1000之間的任何數字。
每個回應都將包含一個next_token
字段中是否有其他結果。設置start_token
到next_token
值將返回結果的下一頁。
排序
可以使用sort
參數,可以設置為created_at
(默認)或modified_at
。您還可以通過設置sort_dir
參數asc
(默認)或desc
。
搜索過濾器
您可以通過添加搜索過濾器參數來限制結果。所有搜索過濾器都是可選的。多個過濾器被視為AND
條件-也就是說,必須將所有條件都包括在內,才能將視頻工作包括在結果中。
可以使用以下格式為單個過濾器指定多個值:
{filter}=[value1,value2]
以這種方式指定的過濾器值被視為OR
條件-如果作業與任何值匹配,則返回該作業。
可能在過濾器值之前包含比較運算符,並用冒號分隔:
{filter}={op}:{value}
運算符為:gt
(比...更棒),ge
(大於或等於),lt
(少於),le
(小於或等於)。例如,要搜索2018年1月1日之後創建的視頻工作:
created_at=gt:1514764800000
從值推斷出過濾器類型。如果需要將數字或布爾值視為字符串,則可以將其用單引號引起來:
{filter}=’1234’
篩選器名稱 | 類型 | 說明/值 |
---|---|---|
user_id |
字符串,字符串數組 | 使用者 ID |
created_at |
整數 | Unix創建作業的時間(以毫秒為單位) |
modified_at |
整數 | Unix作業的最後狀態更改時間(以毫秒為單位) |
static |
布林 | 具有靜態端點(僅適用於列表作業請求) |
state |
字符串,字符串數組 | 一個或多個作業狀態(僅適用於列表作業請求) |
jvod_state |
字符串,字符串數組 | 一個或多個VOD作業狀態(僅適用於列表vod作業請求) |
jvod_type |
字符串,字符串數組 | 一種或多種VOD作業類型(僅適用於列表vod作業請求) |
label |
字符串,字符串數組 | 一個或多個VOD作業標籤(僅適用於列表vod作業請求) |
sep_state |
字符串,字符串數組 | 一個或多個靜態端點狀態(僅適用於列表作業請求) |
ssai_state |
字符串,字符串數組 | 一個或多個SSAI狀態(僅適用於列表作業請求) |
region |
字符串,字符串數組 | 一個或多個區域(僅適用於列表作業請求) |
account_id |
串 | 搜索特定帳戶,或指定“ *”以搜索所有帳戶。默認值為帳戶API密鑰所屬 |
{other_job_fields} |
從字段類型推斷 | 通過指定其內部名稱和值可以過濾其他作業字段 |
範例
以下是一些獲取實時工作的示例請求。
- 獲得完成狀態的實時作業,顯示最新創建的作業:
https://api.bcovlive.io/v1/jobs?state=finished&sort=created_at&sort_dir=desc
- 獲得當前活躍的SEP現場工作
https://api.bcovlive.io/v1/jobs?static=true&sep_state=ready
- 獲取於2018年10月1日或之後創建的實時職位
https://api.bcovlive.io/v1/jobs?created_at=gt:1538428165517