入門
Live API GEThttps://api.bcovlive.io/v1/jobsのエンドポイントへのリクエストにより、作成したライブジョブのリストを取得できます。同様に、ライブジョブの VOD GEThttps://api.bcovlive.io/v1/jobs/{job_id}/vodsジョブのリストを取得するリクエストです。これらのリクエストの詳細については、「 API リファレンス」を参照してください。このトピックでは、概要といくつかの追加の詳細について説明します。記載がない限り、以下に説明するパラメーターは、これらの要求の両方に適用されます。
ページネーション
結果のページネーションは、start_tokenpage_sizeおよびクエリパラメータによって処理されます。ページサイズは、各リクエストで返される結果の数を示し、1 ～ 1000 の任意の数値に設定できます。
追加の結果がある場合、next_token各応答にはフィールドが含まれます。start_tokennext_tokenをの値に設定すると、結果の次のページが返されます。
並べ替える
結果は、パラメータを使用してソートできます。sortこのパラメータはcreated_at (デフォルト) またはに設定できますmodified_at。sort_dirパラメータをasc (デフォルト) またはに設定して、ソート方向を設定することもできますdesc。
検索フィルタ
検索フィルタパラメータを追加することで、結果を絞り込むことができます。すべての検索フィルタはオプションです。AND複数のフィルターは条件として扱われます。つまり、結果に VoD ジョブを含めるには、すべての条件を満たす必要があります。
次の形式を使用して、1 つのフィルタに複数の値を指定できます。
{filter}=[value1,value2]
ORこの方法で指定したフィルタ値は条件として扱われます。いずれかの値に一致すると、ジョブが返されます。
比較演算子は、フィルタ値の前にコロンで区切って含めることができます。
{filter}={op}:{value}
演算子は、gt（より大きい）、ge（より大きい）、（より大きい）、lt（より小さい）、le（より小さい）です。たとえば、2018 年 1 月 1 日以降に作成された VoD ジョブを検索するには:
created_at=gt:1514764800000
フィルタの種類は、値から推定されます。数値またはブール値を文字列として扱う必要がある場合は、一重引用符で囲むことができます。
{filter}=’1234’
| フィルタ名 | タイプ | 説明/値 |
|---|---|---|
user_id |
文字列, 文字列の配列 | ユーザーID |
created_at |
整数 | UNIXジョブ作成時間（ミリ秒単位） |
modified_at |
整数 | ジョブの最終状態変更のUNIX時間（ミリ秒単位） |
static |
ブール値 | 静的エンドポイントがある (リストジョブ要求の場合のみ) |
state |
文字列, 文字列の配列 | 1 つまたは複数のジョブ状態 (リストジョブ要求のみ) |
jvod_state |
文字列, 文字列の配列 | 1 つ以上の VOD ジョブ状態（リストの VoD ジョブリクエストのみ） |
jvod_type |
文字列, 文字列の配列 | 1 つ以上の VOD ジョブタイプ (リストの VOD ジョブリクエストのみ) |
label |
文字列, 文字列の配列 | 1 つ以上の VOD ジョブラベル (リストの VOD ジョブリクエストのみ) |
sep_state |
文字列, 文字列の配列 | 1 つ以上の静的エンドポイント状態 (リストジョブ要求のみ) |
ssai_state |
文字列, 文字列の配列 | 1 つ以上の SSAI 状態 (リストジョブ要求のみ) |
region |
文字列, 文字列の配列 | 1 つ以上のリージョン (リストジョブリクエストのみ) |
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-01 以降に作成されたライブジョブを取得する
https://api.bcovlive.io/v1/jobs?created_at=gt:1538428165517