カテゴリステータスリストの照会
- 印刷する
- PDF
カテゴリステータスリストの照会
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
VOD Stationは、カテゴリのエンコード状態リストを照会するための APIを提供します。
リクエスト
GET https://vodstation.apigw.ntruss.com/api/v2/status
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| pageNo | No | Integer | - リクエストするページ番号 総ページ番号は total/pageSizeNo | |
| pageSizeNo | No | Integer | ページごとのカテゴリ数 | |
| workStartTimeTo | No | Integer | - エンコードリクエスト照会の終了時間 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す | |
| workStartTimeFrom | No | Integer | - エンコードリクエスト照会の開始時間 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す |
カテゴリの状態をページで分けて照会する
- 例: エンコードリクエストしたファイルが30個であれば、ページごとに10個ずつ表示されるようにカテゴリの状態を照会
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=1&pageSizeNo=10
-> 計30個のエンコード対象ファイルをページごとに10個単位でリクエストし、最初のページをリクエスト
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=2&pageSizeNo=10
-> 計30個のエンコード対象ファイルをページごとに10個単位でリクエストし、2番目のページをリクエスト
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=3&pageSizeNo=10
-> 計30個のエンコード対象ファイルをページごとに10個単位でリクエストし、3番目のページをリクエスト
特定の時点にリクエストしたエンコードファイルの状態を照会する
GET https://vodstation.apigw.ntruss.com/api/v2/status?workStartTimeTo=1631404800000&workStartTimeFrom=1631491200000
-> 2021年9月12日午前00:00:00 GMTから、2021年9月13日午前00:00:00 GMTまでリクエストしたエンコードファイルステータスを照会
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| 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} |
レスポンス
| フィールド名 | タイプ | 説明 | 備考 |
|---|---|---|---|
| error | Object | リクエスト失敗時のレスポンス エラーレスポンスコードとメッセージ | |
| error.code | Integer | エラーレスポンスコード | |
| error.message | String | エラーレスポンスメッセージ | |
| content[] | Array(Object) | VOD Station OPEN APIレスポンスオブジェクト | |
| content[].categoryId | String | カテゴリ ID | |
| content[].categoryName | String | カテゴリ名 | |
| content[].filePath | String | 入力ファイル名 | |
| content[].outputType | Integer | 設定されたエンコード設定に応じた出力タイプ数 | |
| content[].link | Boolean | - 出力ファイルのダウンロード URL 出力ファイルの公開範囲が「公開しない」に設定されている場合、アクセスできない可能性がある | |
| content[].outputTotalSize | String | 出力ファイルの総容量(単位: byte) | |
| content[].lastWorkTime | Object | 最後の作業時間 | |
| content[].status | String | エンコードの状態 | COMPLETE, WAITING, RUNNING, FAILURE, CANCELED |
| content[].percent | String | エンコードの進捗率 | |
| total | String | エンコード実行数の合計 |
例
リクエスト例
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=1&pageSizeNo=10
GET /api/v2/status?pageNo=1&pageSizeNo=10
HOST: vodstation.apigw.ntruss.com
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M==
レスポンス例
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": [
{
"categoryId": 10019,
"categoryName": "test2",
"filePath": "SampleVideo_1280x720_5mb_auto_90fps_abr.mp4",
"outputType": "auto_90fps_abr",
"link": "https://kr.object.ncloudstorage.com/.../SampleVideo_1280x720_5mb_AVC_SD_1Pass_30fps.mp4",
"outputTotalSize": 81040256,
"lastWorkTime": "2021-09-14T15:49:12+0900",
"status": "COMPLETE",
"percent": 100
},
],
"total": 1
}
この記事は役に立ちましたか?