チャンネルリストの照会

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

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

リクエスト

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

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N
`pageSizeNo`	Integer	Optional	ページごとの項目数 1~100
`channelStatus`	String	Optional	チャンネルの状態で絞り込み `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PUBLISHING`: 配信中 `DELETED`: 返却 `BLOCK`: 停止 `FORCE_BLOCK`: 強制停止 `FORCE_DELETED`: 使用不可
`id`	String	Optional	チャンネル IDで絞り込み完全一致または一部一致する値を表示
`channelName`	String	Optional	チャンネル名で絞り込み完全一致または一部一致する値を表示

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=1&channelName=chan' \
--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` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PUBLISHING`: 配信中 `DELETED`: 返却 `BLOCK`: 停止 `FORCE_BLOCK`: 強制停止 `FORCE_DELETED`: 使用不可
`isRecording`	Boolean	-	録画中か `true` \| `false` `true`: 録画中 `false`: 録画中ではない
`useDVR`	Boolean	-	タイムシフトを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`immediateOnAir`	Boolean	-	配信と同時に自動録画を設定するか `true` \| `false` `true`: 自動 `false`: 手動
`timemachineMin`	Integer	-	タイムシフトの有効時間(分)
`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のサービス地域
`streamKey`	String	-	メインストリームキー
`publishUrl`	String	-	基本配信 URL
`globalPublishUrl`	String	-	海外配信 URL
`totalPublishSeconds`	Integer	-	チャンネルの使用時間(秒)
`createdTime`	Integer	-	チャンネル作成日時(ミリ秒) Unix Timestamp形式
`alertOn`	Boolean	-	イベントアラームを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`recentPublishStartTime`	Integer	-	直近の配信開始日時(ミリ秒) Unix Timestamp形式初回配信前の場合、表示しない
`alertOptions`	Object	-	イベントアラームを設定
`alertOptions.alertChangeStatus`	Boolean	-	チャンネル状態変更アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertOptions.alertVodUploadFail`	Boolean	-	録画ファイルアップロード失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertOptions.alertReStreamFail`	Boolean	-	同時配信リレー失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertOptions.reStreamFailThreshold`	Integer	-	アラーム発生条件(基準回数)
`alertOptions.alertStreamFailOver`	Boolean	-	メインストリーム切り替えアラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`callbackEndpoint`	String	-	コールバックエンドポイント URL 有効値が存在する場合、表示
`envType`	String	-	チャンネルタイプ `DEV` \| `STAGE` \| `REAL`
`uploadPath`	String	-	録画ファイルアップロードパス `record.type`が`AUTO_UPLOAD`の場合、表示
`record`	Object	-	録画保存情報
`record.type`	String	-	録画保存設定 `NO_RECORD` \| `AUTO_UPLOAD` \| `MANUAL_UPLOAD` `NO_RECORD`: 録画しない `AUTO_UPLOAD`: 自動保存 `MANUAL_UPLOAD`: 一時保存
`record.bucketName`	String	-	録画ファイル保存場所のバケット名 `record.type`が`AUTO_UPLOAD`の場合、表示
`record.filePath`	String	-	保存場所の詳細パス `record.type`が`AUTO_UPLOAD`の場合、表示
`record.format`	String	-	自動保存録画タイプ `MP4` \| `HLS` \| `ALL`
`record.accessControl`	String	-	録画ファイル保存場所バケットの公開範囲 `PRIVATE` \| `PUBLIC_READ` `PRIVATE`: 非公開 `PUBLIC_READ`: 公開 `record.type`が`AUTO_UPLOAD`の場合、表示
`snapshot`	Object	-	スナップショット情報配信中にスナップショットを作成した場合にのみ表示
`snapshot.snapshotId`	Integer	-	スナップショット ID
`origin`	Object	-	オリジン情報
`origin.originDomain`	String	-	オリジンのドメイン
`origin.originPath`	String	-	オリジンのパス
`backupStreamKey`	String	-	バックアップストリームキー配信冗長化設定時、表示
`isStreamFailOver`	Boolean	-	配信冗長化設定 `true` \| `false` `true`: 使用 `false`: 使用しない
`drmEnabledYn`	Boolean	-	Multi DRMの使用 `true` \| `false` `true`: 使用 `false`: 使用しない
`drm`	Object	-	Multi DRM設定 `drmEnabledYn`が`true`の場合、配下の情報を表示
`drm.siteId`	String	-	サイト ID
`drm.contentId`	String	-	コンテンツ ID

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

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

レスポンス例

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

{
    "content": [
        {
            "channelId": "ls-20250813******-SkhxV",
            "channelName": "mychannel",
            "instanceNo": 10*****39,
            "qualitySetId": 2584,
            "qualitySetName": "ll-audio-only",
            "outputProtocol": "LL_HLS",
            "channelStatus": "READY",
            "isRecording": false,
            "useDVR": true,
            "immediateOnAir": true,
            "timemachineMin": 360,
            "cdn": {
                "instanceNo": "11565",
                "serviceName": "edge-ls-20250813******-SkhxV",
                "statusName": "RUNNING",
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "cj***********.edge.naverncp.com",
                "profileId": 4207,
                "regionType": "KOREA"
            },
            "streamKey": "y******************************n",
            "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
            "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
            "totalPublishSeconds": 237,
            "createdTime": 1755070375000,
            "alertOn": true,
            "recentPublishStartTime": 1755128792000,
            "alertOptions": {
                "alertChangeStatus": true,
                "alertVodUploadFail": true,
                "alertReStreamFail": false,
                "reStreamFailThreshold": 2,
                "alertStreamFailOver": true
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "DEV",
            "uploadPath": "/mybucket/",
            "record": {
                "type": "AUTO_UPLOAD",
                "bucketName": "mybucket",
                "filePath": "/",
                "format": "MP4",
                "accessControl": "PRIVATE"
            },
            "origin": {
                "originDomain": "*****.video.media.ntruss.com",
                "originPath": "2*****5"
            },
            "backupStreamKey": "y******************************************e",
            "isStreamFailOver": true,
            "drmEnabledYn": false
        }
    ],
    "total": 2
}