カテゴリ状態の照会

Prev Next

Classic/VPC環境で利用できます。

カテゴリ別エンコード状態の詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v2/status/{fileId}

リクエストヘッダ

VOD Station APIで共通して使用されるヘッダの詳細は、VOD Stationのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
fileId String Required ファイル ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/status/1*****4' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
content Object - レスポンス結果
categoryId Integer - カテゴリ ID
categoryName String - カテゴリ名
content.input Object - 入力ファイル情報
content.input.fileId Integer - 入力ファイル ID
content.input.bucketName String - 入力ファイル保存場所のバケット名
content.input.filePath String - ファイル名を含む入力ファイルのバケットの詳細なパス
content.input.metadata Object - 入力ファイルのメタデータ情報
content.input.metadata.duration Float - ファイルの再生時間(秒)
  • SS.SS形式
content.input.metadata.videoCodec String - ビデオコーデック
content.input.metadata.videoBitrate Float - ビデオビットレート(Kbps)
content.input.metadata.width Integer - ビデオの幅(ピクセル)
content.input.metadata.height Integer - ビデオの高さ(ピクセル)
content.input.metadata.framerate Float - 1秒当たりのフレーム数(fps)
content.input.metadata.audioCodec String - オーディオコーデック
content.input.metadata.audioBitrate Float - オーディオビットレート(Kbps)
content.input.metadata.audioSamplingRate Float - オーディオサンプリングレート(Hz)
content.input.metadata.audioChannel Integer - オーディオチャンネル
content.output Array - 出力ファイル情報: output

output

outputの説明は次の通りです。

フィールド タイプ 必須の有無 説明
encodingOptionId Integer - エンコードオプション ID
outputType String - 出力タイプ
objectStorageUrl String - ファイル名を含む出力ファイルの HTTP URLパス
status String - ファイルエンコード状態
  • COMPLETE | WAITING | RUNNING | FAILURE
    • COMPLETE: 完了
    • WAITING: 待機
    • RUNNING: 処理中
    • FAILURE: 失敗
percentage Float - ファイルエンコード進捗率(%)
metadata Object - 出力ファイルのメタデータ
metadata.duration Float - ファイルの再生時間(秒)
  • SS.SS形式
metadata.videoCodec String - ビデオコーデック
metadata.videoPass String - ビデオパス
metadata.videoBitrate Float - ビデオビットレート(Kbps)
metadata.width Integer - ビデオの幅(ピクセル)
metadata.height Integer - ビデオの高さ(ピクセル)
metadata.framerate Float - 1秒当たりのフレーム数(fps)
metadata.audioCodec String - オーディオコーデック
metadata.audioBitrate Float - オーディオビットレート(Kbps)
metadata.audioSamplingRate Float - オーディオサンプリングレート(Hz)
metadata.audioChannel Integer - オーディオチャンネル

レスポンスステータスコード

VOD Station APIで共通して使用されるレスポンスステータスコードの詳細は、VOD Stationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": {
        "categoryId": *****,
        "categoryName": "VOD-Callback",
        "input": {
            "fileId": 1*****4,
            "metadata": {
                "duration": 8.043,
                "videoCodec": "AVC",
                "videoBitrate": 2667520.0,
                "width": 1280,
                "height": 720,
                "framerate": 24.0,
                "audioCodec": "AAC",
                "audioBitrate": 143360.0,
                "audioSamplingRate": 48000.0,
                "audioChannel": 2
            }
        },
        "output": [
            {
                "encodingOptionId": 1,
                "outputType": "AVC_SD_1Pass_30fps",
                "objectStorageUrl": "https://kr.object.ncloudstorage.com/station-000/VOD-Callback/VODStation_AVC_SD_1Pass_30fps.mp4",
                "status": "COMPLETE",
                "percentage": 100.0,
                "metadata": {
                    "duration": 8.047,
                    "videoCodec": "avc1",
                    "videoPass": "ONE_PASS",
                    "videoBitrate": 478208.0,
                    "width": 480,
                    "height": 270,
                    "framerate": 24.0,
                    "audioCodec": "AAC LC",
                    "audioBitrate": 132096.0,
                    "audioSamplingRate": 44100.0,
                    "audioChannel": 2
                }
            },
            {
                "encodingOptionId": 2,
                "outputType": "AVC_SD_1Pass_30fps_1",
                "objectStorageUrl": "https://kr.object.ncloudstorage.com/station-000/VOD-Callback/VODStation_AVC_SD_1Pass_30fps_1.mp4",
                "status": "COMPLETE",
                "percentage": 100.0,
                "metadata": {
                    "duration": 8.047,
                    "videoCodec": "avc1",
                    "videoPass": "ONE_PASS",
                    "videoBitrate": 872448.0,
                    "width": 854,
                    "height": 480,
                    "framerate": 24.0,
                    "audioCodec": "AAC LC",
                    "audioBitrate": 132096.0,
                    "audioSamplingRate": 44100.0,
                    "audioChannel": 2
                }
            },
            {
                "encodingOptionId": 3,
                "outputType": "AVC_HD_1Pass_30fps",
                "objectStorageUrl": "https://kr.object.ncloudstorage.com/station-000/VOD-Callback/VODStation_AVC_HD_1Pass_30fps.mp4",
                "status": "COMPLETE",
                "percentage": 100.0,
                "metadata": {
                    "duration": 8.047,
                    "videoCodec": "avc1",
                    "videoPass": "ONE_PASS",
                    "videoBitrate": 1737728.0,
                    "width": 1280,
                    "height": 720,
                    "framerate": 24.0,
                    "audioCodec": "AAC LC",
                    "audioBitrate": 132096.0,
                    "audioSamplingRate": 44100.0,
                    "audioChannel": 2
                }
            }
        ]
    }
}