チャンネルの照会

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

同時配信チャンネルの詳細情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/re-stream/channels/{channelId}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`channelId`	String	Required	チャンネル ID チャンネルリストの照会を参照

リクエスト例

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

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

`restream`

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

フィールド	タイプ	必須の有無	説明
`id`	String	-	RTMP認証 ID 認証情報が設定された場合、表示
`rtmpUrl`	String	-	同時配信プラットフォーム RTMP URL
`streamKey`	String	-	同時配信プラットフォームのストリームキー
`password`	String	-	RTMP認証のパスワード認証情報が設定された場合、表示先頭文字を除く文字列をマスキング処理
`targetName`	String	-	同時配信プラットフォーム名

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

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

レスポンス例

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

{
    "content": {
        "channelId": "ls-20250821******-GHiLB",
        "channelName": "channel000",
        "instanceNo": 1083*****,
        "channelStatus": "READY",
        "streamKey": "1uxvnw2z6bxqqy******************",
        "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
        "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
        "planType": "STANDARD",
        "createdTime": 1755757259000,
        "restream": [
            {
                "rtmpUrl": "rtmp://x.rtmp.youtube.com/live2",
                "streamKey": "****-****-****-****-****",
                "targetName": "YOUTUBE"
            }
        ],
        "platformCount": 1,
        "totalPublishSeconds": 177,
        "recentPublishTime": 1755845515000,
        "alertOn": true,
        "isPublishing": false,
        "alertOptions": {
            "alertChangeStatus": true,
            "alertVodUploadFail": false,
            "alertReStreamFail": true,
            "reStreamFailThreshold": 1,
            "alertStreamFailOver": false
        },
        "callbackEndpoint": "https://www.example.com",
        "envType": "REAL"
    }
}