チャンネルリストの照会

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

同時配信チャンネルリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/re-stream/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/re-stream/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 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'

レスポンス

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

レスポンスボディ

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

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

`content`

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

フィールド	タイプ	必須の有無	説明
`channelId`	String	-	チャンネル ID
`channelName`	String	-	チャンネル名
`instanceNo`	Integer	-	チャンネルインスタンス番号
`channelStatus`	String	-	チャンネルの状態 `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PUBLISHING`: 配信中 `DELETED`: 返却 `BLOCK`: 停止 `FORCE_BLOCK`: 強制停止 `FORCE_DELETED`: 使用不可
`streamKey`	String	-	ストリームキー
`publishUrl`	String	-	基本配信 URL
`globalPublishUrl`	String	-	海外配信 URL
`planType`	String	-	料金プランタイプ `STANDARD` \| `PROFESSIONAL` `STANDARD`: 最大3つのプラットフォームに同時配信 `PROFESSIONAL`: 最大5つのプラットフォームに同時配信
`createdTime`	Integer	-	チャンネル作成日時(ミリ秒) Unix Timestamp形式
`platformCount`	Integer	-	同時配信プラットフォーム数
`totalPublishSeconds`	Integer	-	チャンネルの使用時間(秒)
`alertOn`	Boolean	-	イベントアラームを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`isPublishing`	Boolean	-	配信中か `true` \| `false` `true`: 配信中 `false`: 配信中ではない
`alertOptions`	Object	-	イベントアラームを設定
`alertOptions.alertChangeStatus`	Boolean	-	同時配信用チャンネル状態変更アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertOptions.alertVodUploadFail`	Boolean	-	録画ファイルアップロード失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`alertOptions.alertReStreamFail`	Boolean	-	同時配信リレー失敗アラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`content.alertOptions.reStreamFailThreshold`	Integer	-	アラーム発生条件(基準の回数) アラーム初回設定前の場合、表示しない
`alertOptions.alertStreamFailOver`	Boolean	-	メインストリーム切り替えアラームを適用するか `true` \| `false` `true`: 適用 `false`: 適用しない
`callbackEndpoint`	String	-	コールバックエンドポイント URL 有効値が存在する場合、表示
`envType`	String	-	チャンネルタイプ `REAL` \| `DEV` \| `STAGE`

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

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

レスポンス例

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

{
    "content": [
        {
            "channelId": "ls-20250819******-Ik1QU",
            "channelName": "channel001",
            "instanceNo": 1082*****,
            "channelStatus": "READY",
            "streamKey": "zgarlukheigpxu******************",
            "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
            "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
            "planType": "STANDARD",
            "createdTime": 1755571786000,
            "platformCount": 2,
            "totalPublishSeconds": 0,
            "alertOn": false,
            "isPublishing": false,
            "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false,
                "alertStreamFailOver": false
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "REAL"
        }
    ],
    "total": 2
}