チャンネルの停止

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

PUBLISHINGまたはREADY状態のライブチャンネルを停止します。

注意

配信中(PUBLISHING)チャンネルを停止すると、配信中番組が強制的に中断されます。配信を終了してからチャンネルの状態を変更してください。

リクエスト

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

メソッド	URI
PUT	/api/v2/channels/{channelId}/off

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request PUT 'https://livestation.apigw.ntruss.com/api/v2/channels/ls-20250814******-zTwK2/off' \
--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`	Object	-	チャンネル情報
`content.channelId`	String	-	チャンネル ID
`content.channelName`	String	-	チャンネル名
`content.instanceNo`	Integer	-	チャンネルインスタンス番号
`content.qualitySetId`	Integer	-	画質設定 ID
`content.qualitySetName`	String	-	画質設定名
`content.outputProtocol`	String	-	Output Protocol
`content.channelStatus`	String	-	チャンネルの状態 `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PUBLISHING`: 配信中 `DELETED`: 返却 `BLOCK`: 停止 `FORCE_BLOCK`: 強制停止 `FORCE_DELETED`: 使用不可
`content.isRecording`	Boolean	-	録画中か `true` \| `false` `true`: 録画中 `false`: 録画中ではない
`content.useDVR`	Boolean	-	タイムシフトを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`content.immediateOnAir`	Boolean	-	配信と同時に自動録画を設定するか `true` \| `false` `true`: 自動 `false`: 手動
`content.timemachineMin`	Integer	-	タイムシフトの有効時間(分)
`content.cdn`	Object	-	CDNの設定
`content.cdn.instanceNo`	String	-	CDNインスタンス ID
`content.cdn.serviceName`	String	-	CDNサービス名
`content.cdn.statusName`	String	-	CDNの状態 `RUNNING` \| `PUBLISHING` \| `STOPPING` \| `STOPPED` \| `CREATING` \| `CHANGING` \| `CDN_NOT_FOUND` `RUNNING`: 運用中 `PUBLISHING`: デプロイ中 `STOPPING`: 停止中 `STOPPED`: 停止 `CREATING`: 作成中 `CHANGING`: 変更中 `CDN_NOT_FOUND`: CDNが見つからない
`content.cdn.cdnType`	String	-	CDNタイプ `GLOBAL_CDN` \| `GLOBAL_EDGE`
`content.cdn.cdnDomain`	String	-	CDNサービスドメイン
`content.cdn.profileId`	Integer	-	Global Edgeのプロファイル ID
`content.cdn.regionType`	String	-	Global Edgeのサービス地域
`content.streamKey`	String	-	メインストリームキー
`content.publishUrl`	String	-	基本配信 URL
`content.globalPublishUrl`	String	-	海外配信 URL
`content.totalPublishSeconds`	Integer	-	チャンネルの使用時間(秒)
`content.createdTime`	Integer	-	チャンネル作成日時(ミリ秒) Unix Timestamp形式
`content.alertOn`	Boolean	-	イベントアラームを設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`content.recentPublishStartTime`	Integer	-	直近の配信開始日時(ミリ秒) Unix Timestamp形式初回配信前の場合、表示しない
`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	-	チャンネルタイプ `DEV` \| `STAGE` \| `REAL`
`content.uploadPath`	String	-	録画ファイルアップロードパス `content.record.type`が`AUTO_UPLOAD`の場合、表示
`content.record`	Object	-	録画保存情報
`content.record.type`	String	-	録画保存設定 `NO_RECORD` \| `AUTO_UPLOAD` \| `MANUAL_UPLOAD` `NO_RECORD`: 録画しない `AUTO_UPLOAD`: 自動保存 `MANUAL_UPLOAD`: 一時保存
`content.record.bucketName`	String	-	録画ファイル保存場所のバケット名 `content.record.type`が`AUTO_UPLOAD`の場合、表示
`content.record.filePath`	String	-	保存場所の詳細パス `content.record.type`が`AUTO_UPLOAD`の場合、表示
`content.record.format`	String	-	自動保存録画タイプ `MP4` \| `HLS` \| `ALL`
`content.record.accessControl`	String	-	録画ファイル保存場所バケットの公開範囲 `PRIVATE` \| `PUBLIC_READ` `PRIVATE`: 非公開 `PUBLIC_READ`: 公開 `content.record.type`が`AUTO_UPLOAD`の場合、表示
`content.origin`	Object	-	オリジン情報
`content.origin.originDomain`	String	-	オリジンのドメイン
`content.origin.originPath`	String	-	オリジンのパス
`content.backupStreamKey`	String	-	バックアップストリームキー配信冗長化設定時、表示
`content.isStreamFailOver`	Boolean	-	配信冗長化設定 `true` \| `false` `true`: 使用 `false`: 使用しない
`content.drmEnabledYn`	Boolean	-	Multi DRMの使用 `true` \| `false` `true`: 使用 `false`: 使用しない
`content.drm`	Object	-	Multi DRM設定 `content.drmEnabledYn`が`true`の場合、配下の情報を表示
`content.drm.siteId`	String	-	サイト ID
`content.drm.contentId`	String	-	コンテンツ ID

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

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

レスポンス例

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

{
    "content": {
        "channelId": "ls-20250814******-zTwK2",
        "channelName": "mytestchannel",
        "instanceNo": 10******6,
        "qualitySetId": 5,
        "qualitySetName": "480p-set",
        "outputProtocol": "HLS",
        "channelStatus": "BLOCK",
        "isRecording": false,
        "useDVR": true,
        "immediateOnAir": true,
        "timemachineMin": 360,
        "cdn": {
            "instanceNo": "11577",
            "serviceName": "edge-ls-20250814******-PZohi",
            "statusName": "RUNNING",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "*************.edge.naverncp.com",
            "profileId": 4207,
            "regionType": "KOREA"
        },
        "streamKey": "5t*****************************9",
        "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
        "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
        "totalPublishSeconds": 1060,
        "createdTime": 1755149311000,
        "alertOn": true,
        "recentPublishStartTime": 1755154275000,
        "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false,
            "reStreamFailThreshold": 2,
            "alertStreamFailOver": false
        },
        "callbackEndpoint": "https://www.example.com",
        "envType": "REAL",
        "uploadPath": "/mybucket/",
        "record": {
            "type": "AUTO_UPLOAD",
            "bucketName": "mybucket",
            "filePath": "/",
            "format": "MP4",
            "accessControl": "PRIVATE"
        },
        "origin": {
            "originDomain": "*****.video.media.ntruss.com",
            "originPath": "2*****5"
        },
        "backupStreamKey": "5t*****************************************e",
        "isStreamFailOver": true,
        "drmEnabledYn": false
    }
}