チャンネルリストの照会

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/vod/channels' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`content`	Array	-	チャンネルリスト: content
`total`	Integer	-	レスポンス総数

`content`

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

フィールド	タイプ	必須の有無	説明
`channelId`	String	-	チャンネル ID
`channelName`	String	-	チャンネル名
`instanceNo`	Integer	-	チャンネルインスタンス番号
`qualitySetId`	Integer	-	画質設定 ID
`qualitySetName`	String	-	画質設定名
`outputProtocol`	String	-	Output Protocol
`channelStatus`	String	-	チャンネルの状態 `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `RESERVED` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PUBLISHING`: 配信中 `DELETED`: 返却 `BLOCK`: 停止 `RESERVED`: 配信予約 `FORCE_BLOCK`: 強制停止 `FORCE_DELETED`: 使用不可
`cdn`	Object	-	CDNの設定
`cdn.instanceNo`	String	-	CDNインスタンス ID
`cdn.serviceName`	String	-	CDNサービス名
`cdn.statusName`	String	-	CDNの状態 `RUNNING` \| `PUBLISHING` \| `STOPPING` \| `STOPPED` \| `CREATING` \| `CHANGING` \| `CDN_NOT_FOUND` `RUNNING`: 運用中 `PUBLISHING`: デプロイ中 `STOPPING`: 停止中 `STOPPED`: 停止 `CREATING`: 作成中 `CHANGING`: 変更中 `CDN_NOT_FOUND`: CDNが見つからない
`cdn.cdnType`	String	-	CDNタイプ `GLOBAL_CDN` \| `GLOBAL_EDGE`
`cdn.cdnDomain`	String	-	CDNサービスドメイン
`cdn.profileId`	Integer	-	Global Edgeのプロファイル ID
`cdn.regionType`	String	-	Global Edgeのサービス地域
`totalPublishSeconds`	Integer	-	チャンネルの使用時間(秒)
`createdTime`	Integer	-	チャンネル作成日時(ミリ秒) Unix Timestamp形式
`updatedTime`	Integer	-	チャンネル更新日時(ミリ秒) Unix Timestamp形式
`alertOn`	Boolean	-	イベントアラームを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`recentPublishTime`	Integer	-	直近の配信開始日時(ミリ秒) Unix Timestamp形式初回配信前の場合、表示しない
`alertOptions`	Object	-	イベントアラームを設定
`alertOptions.alertChangeStatus`	Boolean	-	チャンネル状態変更アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`callbackEndpoint`	String	-	コールバックエンドポイント URL 有効値が存在する場合、表示
`envType`	String	-	チャンネルタイプ `DEV` \| `STAGE` \| `REAL`
`type`	String	-	チャンネルの種類 `VOD`
`scheduleList`	Array	-	スケジュールリスト: scheduleList
`drmEnabledYn`	Boolean	-	Multi DRMの使用 `true` \| `false` `true`: 使用 `false`: 使用しない
`drm`	Object	-	Multi DRM設定 `drmEnabledYn`が`true`の場合、配下の情報を表示
`drm.siteId`	String	-	サイト ID
`drm.contentId`	String	-	コンテンツ ID

`scheduleList`

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

フィールド	タイプ	必須の有無	説明
`scheduleId`	Integer	-	スケジュール ID
`status`	String	-	スケジュールの状態

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

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

レスポンス例

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

{
    "content": [
        {
            "channelId": "ls-20250820******-qdrMQ",
            "channelName": "V2lTestChannel",
            "instanceNo": 10******4,
            "qualitySetId": 3,
            "qualitySetName": "1080p-set",
            "outputProtocol": "HLS",
            "channelStatus": "READY",
            "cdn": {
                "instanceNo": "1****",
                "serviceName": "edge-ls-20250814******-PZohi",
                "statusName": "RUNNING",
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "*************.edge.naverncp.com",
                "profileId": 4207,
                "regionType": "KOREA"
            },
            "totalPublishSeconds": 0,
            "createdTime": 1755657043000,
            "updatedTime": 1755657043000,
            "alertOn": false,
            "alertOptions": {
                "alertChangeStatus": false
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "REAL",
            "type": "VOD",
            "drmEnabledYn": true,
            "drm": {
                "siteId": "drm-20250814******-gJMis",
                "contentId": "my-Test-Multidrm"
            }
        },
        {
            "channelId": "ls-20250818******-C6e7r",
            "channelName": "v2l_test",
            "instanceNo": 10******3,
            "qualitySetId": 3,
            "qualitySetName": "1080p-set",
            "outputProtocol": "HLS",
            "channelStatus": "READY",
            "cdn": {
                "instanceNo": "1****",
                "serviceName": "edge-ls-20250814*******PZohi",
                "statusName": "RUNNING",
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "*************.edge.naverncp.com",
                "profileId": 4207,
                "regionType": "KOREA"
            },
            "totalPublishSeconds": 11825,
            "createdTime": 1755504277000,
            "updatedTime": 1755660367000,
            "alertOn": false,
            "recentPublishTime": 1755648542000,
            "alertOptions": {
                "alertChangeStatus": false
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "REAL",
            "type": "VOD",
            "scheduleList": [
                {
                    "scheduleId": 1289,
                    "status": "FINISH"
                }
            ],
            "drmEnabledYn": false
        }
    ],
    "total": 2
}