ULIZA En-Cluster (Cloud) API 仕様書 (1.12.0)

本書は ULIZA En-Cluster (Cloud) が提供する API 仕様について記述しています。ULIZA En-Cluster (Cloud) の機能や制限、管理画面の操作方法については ULIZA En-Cluster (Cloud) ユーザーガイド を参照してください。

なお、本書に掲載しているコードサンプル(Request samples)は、具体的な実装例を示すことで開発者を支援することを目的としていますが、掲載しているコードがすべての環境において正常に動作することを保証するものではありません。また、コードサンプル内で使用している関数やライブラリの安全性に関して、弊社は何ら責任を負うものではありません。

string 型のパラメータに使用可能な文字は、特記のない限り半角英数字およびハイフン、アンダースコアのみです。

注意

本書に記述している API を利用するには、対応するオプション(「ULIZA FLEX II - マルチ WebAPI オプション」など)のご契約が必要となります。詳細については お問い合わせ ください。

CHANGELOG

バージョン 改版日 改版内容
v1.0.0 2018/05/31 初版
v1.1.0 2019/04/12 a. プリセット管理系 APIlicense_server_account プロパティを追加
b. タスク登録 APIupload_type プロパティを追加
v1.2.0 2019/09/30 a. ULIZA VMS (Cloud) へのコンテンツ登録のプロパティを追加
b. タスク取得 APIformatHLS 関連の新たなプロパティを追加
c. タスク登録 API にプリセット・オーバーライド機能関連のプロパティを追加
v1.2.1 2019/11/28 a. プロファイル管理系 APIvms_configseek_preview プロパティを追加
v1.3.0 2020/02/25 a. プリセット管理系 APIdestination プロパティにおいて 任意のAWS S3 バケットの指定に対応
b. プリセット管理系 APIdestination_settingsプロパティを追加
c. プリセット管理系 APIposterdestination および filename_prefix プロパティを追加
d. プリセット管理系 APIstreamswatermarks プロパティを追加
e. プリセット管理系 APIformat プロパティにおいて PASSTHROUGH の指定に対応
f. AWS 外部 ID 取得 API を追加
g. タスク登録 APIposter_filename_prefix プロパティを追加
h. タスク取得 API およびタスク詳細取得 APIposter プロパティを追加
v1.5.0 2021/03/15 a. プリセット管理系 APIhls_configmulti_audio_flag プロパティを追加
v1.5.4 2021/06/28 a. トップページの説明文を変更
b. API 全体に403エラーのレスポンスを追加
c. タスク削除 API の名称をタスクキャンセル/削除 API に変更
d. タスク登録 APIタスク全削除 APIタスクキャンセル/削除 APIプリセット登録 APIプロファイル登録 API に説明文を追加
v1.5.5 2021/07/12 a. タスク登録 API の説明文を変更
v1.6.0 2021/10/05 a. 通知設定系 API を追加
v1.7.0 2021/11/22 a. 通知設定系 APInotify_imported_tasks プロパティを追加
b. CSV インポートジョブ管理系 API を追加
v1.8.0 2022/02/22 a. タスク登録 APItrim プロパティを追加
v1.9.0 2022/03/16 a. タスク登録 APImulti_angles プロパティと multi_angle_labels プロパティを追加
v1.10.0 2022/06/07 a. プリセット管理系 APIdynamic_streams プロパティを追加
b. プリセット管理系 APIvideoheight プロパティを追加
v1.11.0 2022/10/04 a. 入力ファイル詳細取得 API に説明文を追加
b. タスク登録 APIvms_config プロパティに説明文を追加
v1.11.1 2023/04/05 a. タスク登録 APIinput_filepath プロパティと output_filename のプロパティの最大文字数を 70 に変更
v1.12.0 2024/04/03 a. 共有プロファイル全取得 API を追加
b. プロファイル管理系 APIshare プロパティを追加

Authentication

特に断りのない限り、本書に記載されている全ての API に対するリクエストの Authorization ヘッダに下記の形式で有効な API 認証キーを含める必要があります。API 認証キーの取得方法については ULIZA プロダクトアカウントユーザーガイド を参照してください。リクエストに有効な API 認証キーが含まれていない場合は、401 Unauthorized が返却されます。

Authorization: Bearer <api-credential>

Authorization

ユーザー認証系 API について以下に記述します。

AWS 外部 ID 取得 API

任意の S3 バケットにアップロードするために必要な IAM ロールの作成時に使用する外部 ID を取得します。

Responses

Response Schema: application/json
external_id
string [ 2 .. 96 ] characters

外部 ID

Request samples

curl \
  -H 'Authorization: Bearer {your-token}' \
  'https://encluster-api.p.uliza.jp/v1/external_id'

Response samples

Content type
application/json
{
  • "external_id": "4c4d59cf271f4f99060bb91630558c36f1c8566f14fe6494ea62874429771c79"
}

Tasks

タスク管理系 API について以下に記述します。

タスク件数取得 API

ステータスごとのタスク件数を取得します。リクエスト送信者が タスクの取得 権限を持っていない場合は、403 Forbidden が返却されます。

Responses

Response Schema: application/json
waiting
integer >= 0

ステータスが準備中のタスク件数

encoding
integer >= 0

ステータスがエンコード中のタスク件数

uploading
integer >= 0

ステータスがアップロード中のタスク件数

ready
integer >= 0

ステータスが完了のタスク件数

canceling
integer >= 0

ステータスがキャンセル中のタスク件数

canceled
integer >= 0

ステータスがキャンセル済みのタスク件数

failed
integer >= 0

ステータスがエラーのタスク件数

Request samples

curl \
  -H 'Authorization: Bearer {your-token}' \
  'https://encluster-api.p.uliza.jp/v1/counts'

Response samples

Content type
application/json
{
  • "waiting": 0,
  • "encoding": 2,
  • "uploading": 1,
  • "ready": 34,
  • "canceling": 0,
  • "canceled": 4,
  • "failed": 0
}

タスク取得 API

タスクの情報を取得します。リクエスト送信者が タスクの取得 権限を持っていない場合は、403 Forbidden が返却されます。

query Parameters
page
integer >= 1
Default: 1

取得するページ番号

per_page
integer [ 1 .. 100 ]
Default: 10

1 ページあたりの取得件数

sort
string
Default: "created_at|desc"

ソートする列名および方向(昇順 asc または降順 desc)を | で連結した文字列。使用可能な列名は以下の通りです。

  • id : タスク ID
  • input_filename : 入力ファイル名
  • output_filename : 出力ファイル名
  • preset_id : プリセット ID
  • preset_name : プリセット名
  • format : フォーマット
  • status : ステータス
  • created_at : タスク登録日時
  • updated_at : タスク更新日時

Responses

Response Schema: application/json
Array of objects

タスク情報

total
integer >= 0

タスク総数

per_page
integer [ 1 .. 100 ]

1 ページあたりの取得件数

current_page
integer >= 1

現在のページ番号

last_page
integer >= 1

最終ページ番号

from
integer >= 0

現在のページの開始番号

to
integer >= 0

現在のページの終了番号

Request samples

curl \
  -H 'Authorization: Bearer {your-token}' \
  'https://encluster-api.p.uliza.jp/v1/tasks?page=2&per_page=10&sort=created_at|desc'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 41,
  • "per_page": 10,
  • "current_page": 2,
  • "last_page": 5,
  • "from": 11,
  • "to": 20
}

タスク登録 API

新規のタスクを登録します。リクエスト送信者が タスクの登録 権限を持っていない場合は、403 Forbidden が返却されます。

タスク登録によってタスク登録可能数を超過すると、エラーコード OVER_SERVICE_LIMIT と共に 403 Forbidden が返却され、タスク登録に失敗します。この場合は、登録済みのタスクのステータスが完了、キャンセル済み、エラーのいずれかに変化することで再びタスク登録を行えるようになります。現在のタスク登録可能数はアカウント設定画面の基本情報から確認することができます。

Request Body schema: application/json
input_filepath
string [ 1 .. 70 ] characters

入力ファイルのファイルパス

profile_id
integer >= 1