リクエスト

PUT https://vodstation.apigw.ntruss.com/api/v2/category/{categoryId}/add-files

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルで発行された Access Key Id値 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content typeを application/jsonに指定 `Content-Type: application/json`

リクエストボディ

APIリクエスト時にフィールド名の大文字・小文字の区別が必要です。

フィールド名	必須の有無	タイプ	制約事項	デフォルト値	説明
bucketName	Yes	String			入力ファイルがアップロードされているバケット名、 httpDownload URLまたは bucketName、filePathを入力してください。
pathList	Yes	Array(String)	100個以下の入力ファイルに対応		ファイル名を含む入力ファイルの詳細パス、httpDownload URLまたは bucketName、filePathを入力してください。
httpDownloadUrlList	Yes	Array(String)	100個以下の入力ファイルに対応、 http url形式、 AVI、MOV、MP4、MP3、3GP、MPG、MPEG、M4V、VOB、WMV、ASF、MKV、FLV、WEBM、GIF、AV1、MXFの拡張子のみ入力可能		ファイル名を含む入力ファイルの詳細パス、httpDownload URLまたは bucketName、filePathを入力してください。
notificationUrl	No	String			入力ファイルに対する Callback URL設定(Overwrite Category notificationUrl Field)
output	No	Object			入力ファイルに対する出力設定(Overwrite Category output Field)
output.bucketName	Yes	String			出力バケット名
output.filePath	Yes	String			出力ファイルをアップロードする詳細パス
output.thumbnailBucketName	Optional	String	入力しない場合、カテゴリ設定に従う		サムネイル出力バケット名
output.thumbnailFilePath	Optional	String	入力しない場合、カテゴリ設定に従う最低1文字以上、最大256文字まで入力(英字、数字、< > : " / \ ? * %を除く特殊文字は入力可能)		サムネイル出力ファイルをアップロードする詳細パス
output.accessControl	No	String	PUBLIC_READ, PRIVATE	PRIVATE	出力ファイルの公開範囲
output.thumbnailAccessControl	No	String	PUBLIC_READ, PRIVATE	PRIVATE	出力サムネイルの公開範囲
output.withoutCategoryName	No	Boolean	true, false	false	Output出力パスにカテゴリ名のフォルダ作成の有無
setAdvancedOptions	No	Boolean	true, false	false	高度な設定の別途設定の有無
advancedOptions	No	Object		NULL	高度な設定
advancedOptions.trimming	No	Object		NULL	出力ファイルのトリミング設定
advancedOptions.trimming.startTimeCode	Yes	String	フォーマット: "HH:MM:SS.S"		- トリミングの開始時点タイムコードフォーマットに合わせて値を入力
advancedOptions.trimming.endTimeCode	Yes	String	フォーマット: "HH:MM:SS.S", startTimeCodeより小さな値は入力不可		- トリミングの終了時点タイムコードフォーマットに合わせて値を入力
advancedOptions.imageOverlay	No	Object		NULL	画像オーバーレイ設定
advancedOptions.imageOverlay.input	Yes	Object			入力画像
advancedOptions.imageOverlay.input.bucketName	Yes	String			入力画像がアップロードされているバケット名
advancedOptions.imageOverlay.input.filePath	Yes	String			ファイル名を含む入力画像の詳細パス
advancedOptions.imageOverlay.position	Yes	Object			挿入する画像位置の設定
advancedOptions.imageOverlay.position.x	Yes	Integer			x軸の位置
advancedOptions.imageOverlay.position.y	Yes	Integer			y軸の位置
advancedOptions.imageOverlay.size	Yes	Obejct			挿入する画像サイズの設定
advancedOptions.imageOverlay.size.width	Yes	Integer			画像の幅
advancedOptions.imageOverlay.size.height	Yes	Integer			画像の高さ

レスポンス

フィールド名	タイプ	説明	備考
content[]	Array(Object)	VOD Station OPEN APIレスポンスオブジェクト
content[].id	Integer	ファイルエンコードタスク ID
content[].bucketName	String	入力ファイルがアップロードされているバケット名
content[].pathList	Array(String)	ファイル名を含む入力ファイルの詳細なパス
content[].httpDownloadUrl	Array(String)	外部からダウンロードする HTTP URL
content[].status	String	ファイルのエンコードステータス	COMPLETE, WAITING, RUNNING, FAILURE, CANCELED
content[].notificationUrl	String	Callback URL設定
content[].output	Object	出力設定
content[].output.bucketName	String	出力バケット名
content[].output.filePath	String	入力ファイルをアップロードする詳細パス
content[].output.thumbnailBucketName	String	サムネイル出力バケット名
content[].output.thumbnailFilePath	String	サムネイル出力出力ファイルのアップロードの詳細パス
content[].output.accessControl	String	出力ファイルの公開範囲
content[].output.thumbnailAccessControl	String	出力サムネイルの公開範囲
content[].output.withoutCategoryName	Boolean	Output出力パスにカテゴリ名のフォルダ作成の有無
content[].advancedOptions	Object	高度な設定
content[].advancedOptions.trimming	Object	出力ファイルのトリミング設定
content[].advancedOptions.trimming.startTimeCode	String	トリミングの開始時点
content[].advancedOptions.trimming.endTimeCode	String	トリミングの終了時点
content[].advancedOptions.imageOverlay	Object	画像オーバーレイ設定
content[].advancedOptions.imageOverlay.input	Object	入力画像
content[].advancedOptions.imageOverlay.input.bucketName	String	入力画像がアップロードされているバケット名
content[].advancedOptions.imageOverlay.input.filePath	String	入力画像の詳細パス
content[].advancedOptions.imageOverlay.position	Object	挿入する画像位置の設定
content[].advancedOptions.imageOverlay.position.x	Integer	x軸の位置
content[].advancedOptions.imageOverlay.position.y	Integer	y軸の位置
content[].advancedOptions.imageOverlay.size	Obejct	挿入する画像サイズの設定
content[].advancedOptions.imageOverlay.size.width	Integer	画像の幅
content[].advancedOptions.imageOverlay.size.height	Integer	画像の高さ

例

リクエスト例

PUT https://vodstation.apigw.ntruss.com/api/v2/category/10095/add-files

PUT /api/v2/category/10095/add-files
HOST: vodstation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M==

{
  "bucketName": "vs-input",
  "pathList": [
    "SampleVideo_1280x720_5mb.mp4", "/1-path/SampleVideo_1920x1080_5m.mp4"
  ]
}

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
  "content": [
    {
      "id": 10240,
      "bucketName": "vs-input",
      "filePath": "SampleVideo_1280x720_5mb.mp4",
      "status": "WAITING"
    },
    {
      "id": 10241,
      "bucketName": "vs-input",
      "filePath": "/1-path/SampleVideo_1920x1080_5m.mp4",
      "status": "WAITING"
    }
  ]
}

この記事は役に立ちましたか?

リクエスト
- リクエストヘッダ
- リクエストボディ
レスポンス
例
- リクエスト例
- レスポンス例

タグ

VOD Station