チャンネルリストの照会

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

チャンネルリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSizeNo`	Integer	Optional	ページごとの項目数 1~N (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=20' \
--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の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`disabled`	Boolean	-	Sub Accountは無効化するか `true` \| `false` `true`: 無効化 `false`: 有効化
`id`	String	-	チャンネル ID
`name`	String	-	チャンネル名
`channelStatus`	String	-	チャンネルの状態 `CREATING` \| `READY` \| `STOPPING` \| `STOPPED` \| `TERMINATING` \| `TERMINATED` \| `FORCE_STOPPING` \| `FORCE_STOPPED` \| `FORCETERMINATING` \| `FORCETERMINATED` `CREATING`: 作成中 `READY`: 運用中 `STOPPING`: 停止中 `STOPPED`: 停止完了 `TERMINATING`: 削除中 `TERMINATED`: 削除完了 `FORCE_STOPPING`: 強制停止中 `FORCE_STOPPED`: 強制停止完了 `FORCETERMINATING`: 強制削除中 `FORCETERMINATED`: 強制削除完了
`storageBucketName`	String	-	チャンネルがストリーミングする映像が保存されているバケット名
`segmentDuration`	Integer	-	セグメントあたりの再生時間(秒)
`protocolList`	Array	-	ストリーミングプロトコルリスト `HLS` \| `DASH`
`createTime`	Integer	-	チャンネル作成開始日時(秒) Unix Timestamp形式
`readyTime`	Integer	-	チャンネル作成完了日時(秒) Unix Timestamp形式
`cdnCreatedTime`	Integer	-	チャンネルと連携して自動作成された CDNの作成日時(秒) Unix Timestamp形式
`stopTime`	Integer	-	チャンネル停止日時(秒) Unix Timestamp形式 `channelStatus`が`STOPPED`(停止完了)の場合、表示
`playUrl`	String	-	CDNによる再生 URLテンプレート
`cdnStatus`	String	-	チャンネルと連携された CDNの状態自動作成しない場合、`NOT_FOUND`と表示
`cdnDomain`	String	-	自動作成された Global Edgeのドメイン
`cdnServiceName`	String	-	自動作成された Global Edgeのサービス名
`storageBucketStatus`	String	-	チャンネルと連携された Object Storageバケットの状態
`originPath`	String	-	作成したチャンネルのオリジンパス別途 CDNの作成時に使用
`encryptList`	Array	-	チャンネルのコンテンツ保護設定情報: encryptList
`accessPrivateFiles`	Boolean	-	バケット内の非公開ファイルへのアクセス制限を設定するか `true` \| `false` (デフォルト) `true`: 許可 `false`: 制限許可すると非公開ファイルもストリーミング可能
`encryptedBucketName`	String	-	チャンネルと連携されたバケットの暗号化された名前再生 URL作成時に使用
`segmentDurationOption`	String	-	セグメント分割方法の設定 `BASIC` \| `VARIABLE` `BASIC`: `segmentDuration` 設定間隔で一定したセグメントを作成 `VARIABLE`: すべてのセグメントがキーフレーム(keyframe)で始まるようにセグメントを作成 `VARIABLE`オプションを選択した場合、`segmentDuration`値と実際に作成されたセグメント再生時間に差が生じる可能性がある
`cdn`	Object	-	自動作成された CDN(Global Edge)情報
`cdn.cdnType`	String	-	CDNのタイプ `GLOBAL_EDGE` (有効値)
`cdn.cdnDomain`	String	-	自動作成された Global Edgeのドメイン
`cdn.cdnServiceName`	String	-	自動作成された Global Edgeのサービス名
`cdn.profileId`	Integer	-	自動作成された Global Edgeのプロファイル ID
`cdn.regionType`	String	-	自動作成された Global Edgeのサービス地域
`cdn.cdnInstanceNo`	Integer	-	自動作成された Global Edgeのインスタンス情報

`encryptList`

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

フィールド	タイプ	必須の有無	説明
`drmContentId`	String	Optional	DRMコンテンツ ID DRM Keyのリクエスト時にこの値を含めてリクエスト、ライセンス(License)発行時に必要
`drmKeyUrl`	String	-	DRM Key URL DRMプロバイダの CPIX API URL VOD Stationは正式に Inka Pallyacon DRMの CPIX v1 APIとの連携をサポート
`systemIdList`	Array	-	DRMシステム ID DRMシステムの固有 ID
`drmTypeCode`	Integer	Optional	DRMタイプ `21` \| `22` `21`: FairPlay `22`: Widevine/PlayReady
`drmTypeName`	String	-	DRMタイプ名
`protocol`	String	-	設定されたプロトコル `HLS` \| `DASH` `HLS`: FairPlay/Media Encryption `DASH`: Widevine/PlayReady
`mediaEncryptTypeCode`	Integer	Optional	設定された Media Encryption(HLS AES-128)コード設定 `1` \| `2` \| `3` `1`: AES-128 `2`: Sample-AES `3`: CENC
`mediaEncryptionTypeName`	String	-	設定された Media Encryption(HLS AES-128)タイプ名 `AES-128` \| `Sample-AES` \| `CENC`

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

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

レスポンス例

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

{
    "content": [
        {
            "disabled": false,
            "id": "vs-20250821095732-*******",
            "name": "ch-media-encrypt",
            "channelStatus": "READY",
            "storageBucketName": "station-000",
            "segmentDuration": 10,
            "protocolList": [
                "HLS"
            ],
            "createTime": 1755737852,
            "readyTime": 1755737880,
            "cdnCreatedTime": 1755737852,
            "playUrl": "https://cpzplvi******.edge.naverncp.com/[protocol]/[Object Storage Bucket(encryption name)]/[path]/[video filename]/[manifest]",
            "cdnStatus": "RUNNING",
            "cdnDomain": "cpzplvi******.edge.naverncp.com",
            "cdnServiceName": "edge-vs-20250821095732-*******",
            "storageBucketStatus": "RUNNING",
            "originPath": "vs2-k1.video.media.ntruss.com/2706412/vs-20250821095732-*******",
            "encryptList": [
                {
                    "protocol": "HLS",
                    "mediaEncryptTypeCode": 1
                }
            ],
            "accessPrivateFiles": true,
            "encryptedBucketName": "*****VzPmKvIthkozoufHw__",
            "segmentDurationOption": "BASIC",
            "cdn": {
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "cpzplvi******.edge.naverncp.com",
                "cdnServiceName": "edge-vs-20250821095732-*******",
                "profileId": ****,
                "regionType": "KOREA",
                "cdnInstanceNo": *****
            }
        }
    ],
    "total": 1
}