カテゴリ状態リストの照会

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

カテゴリ別エンコード状態リストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/status

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSizeNo`	Integer	Optional	ページごとの項目数 10~N (デフォルト: 20)
`workStartTimeFrom`	Integer	Optional	照会開始日時(ミリ秒) Unix Timestamp形式
`workStartTimeTo`	Integer	Optional	照会終了日時(ミリ秒) Unix Timestamp形式

リクエスト例

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

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=1&pageSizeNo=20&workStartTimeFrom=1755590820000&workStartTimeTo=1755591000000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`content`	Array	-	カテゴリエンコード状態リスト: content
`total`	Integer	-	レスポンス総数

`content`

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

フィールド	タイプ	必須の有無	説明
`categoryId`	Integer	-	カテゴリ ID
`categoryName`	String	-	カテゴリ名
`filePath`	String	-	ファイル名を含む入力ファイルのバケットの詳細なパス
`outputType`	String	-	出力タイプ
`link`	String	-	ファイル名を含む出力ファイルの HTTP URLパス
`outputTotalSize`	Long	-	出力ファイルのサイズ(Byte)
`lastWorkTime`	String	-	最終ジョブ実行日時 ISO 8601形式
`status`	String	-	ファイルエンコード状態 `COMPLETE` \| `WAITING` \| `RUNNING` \| `FAILURE` \| `CANCELED` `COMPLETE`: 完了 `WAITING`: 待機 `RUNNING`: 処理中 `FAILURE`: 失敗 `CANCELED`: キャンセル
`percent`	Float	-	ファイルエンコード進捗率(%)

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

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

レスポンス例

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

{
    "content": [
        {
            "categoryId": *****,
            "categoryName": "VOD-Category",
            "filePath": "VODStation.mp4",
            "outputType": "AVC_HD_1Pass_30fps",
            "link": "https://kr.object.ncloudstorage.com/station-000/VOD-Category/VODStation_AVC_HD_1Pass_30fps.mp4",
            "outputTotalSize": 1831292,
            "lastWorkTime": "2025-08-19T17:08:03+0900",
            "status": "COMPLETE",
            "percent": 100.0
        },
        {
            "categoryId": *****,
            "categoryName": "VOD-Category",
            "filePath": "VODStation.mp4",
            "outputType": "AVC_SD_1Pass_30fps_1",
            "link": "https://kr.object.ncloudstorage.com/station-000/VOD-Category/VODStation_AVC_SD_1Pass_30fps_1.mp4",
            "outputTotalSize": 986818,
            "lastWorkTime": "2025-08-19T17:08:03+0900",
            "status": "COMPLETE",
            "percent": 100.0
        },
        {
            "categoryId": *****,
            "categoryName": "VOD-Category",
            "filePath": "VODStation.mp4",
            "outputType": "AVC_SD_1Pass_30fps",
            "link": "https://kr.object.ncloudstorage.com/station-000/VOD-Category/VODStation_AVC_SD_1Pass_30fps.mp4",
            "outputTotalSize": 601601,
            "lastWorkTime": "2025-08-19T17:08:03+0900",
            "status": "COMPLETE",
            "percent": 100.0
        }
    ],
    "total": 3
}