チャンネルの停止

リクエスト

注意

RESERVED、PUBLISHING状態の場合にのみ VODチャンネルを停止できます。

PUT https://livestation.apigw.ntruss.com/api/v2/vod/channels/{channelId}/off

リクエストヘッダ

ヘッダ名	必須の有無	説明
x-ncp-apigw-timestamp	YES	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	NAVERクラウドプラットフォームポータルから発行された Access Key ID `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Access Key IDと Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	YES	Request body content typeを application/jsonに指定 `Content-Type: application/json`
x-ncp-region_code	YES	リージョンコード (KR)

ヘッダ名

必須の有無

説明

x-ncp-apigw-timestamp

YES

1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-apigw-timestamp:{Timestamp}

x-ncp-iam-access-key

YES

NAVERクラウドプラットフォームポータルから発行された Access Key ID
x-ncp-iam-access-key:{Sub Account Access Key}

x-ncp-apigw-signature-v2

YES

Access Key IDと Secret Keyで暗号化した署名
x-ncp-apigw-signature-v2:{API Gateway Signature}

Content-Type

YES

Request body content typeを application/jsonに指定
Content-Type: application/json

x-ncp-region_code

YES

リージョンコード (KR)

レスポンス

フィールド名	タイプ	説明	備考
channelName	String
channelId	String
instanceNo	String
channelStatus	String	CREATING、READY、PUBLISHING、DELETED、BLOCK、RESERVED、FORCE_BLOCK、FORCE_DELETED	VODチャンネルは RESERVED、PUBLISHINGの状態でのみ停止可能
cdn	Object
cdn.cdnType	String	GLOBAL_CDN、GLOBAL_EDGE
cdn.instanceNo	String		NO_CDNの場合は0
cdn.profileId	Integer	Global Edgeのプロファイル ID	NO_CDNの場合は0
cdn.statusName	String	CDNの状態	RUNNING、PUBLISHING、STOPPING、STOPPED、CREATING、CHANGING、CDN_NOT_FOUND
cdn.serviceName	String	CDN Service Name	NO_CDNの場合は""
cdn.cdnDomain	String	CDN Domain	NO_CDNの場合は""
qualitySetId	Integer
qualitySetName	String
outputProtocol	String
alertOn	Boolean
alertOptions	Object
totalPublishSeconds	Integer
createdTime	Integer
updatedTime	Integer
envType	String	DEV、STAGE、REAL
type	String	VOD
callbackEndpoint	String
scheduleList	Array		スケジュールが存在する場合にのみレスポンス
scheduleList.scheduleId	Integer
scheduleList.status	String
drmEnabledYn	Boolean	DRM Encryption設定の適用有無
drm	Object	Live Stationを利用した DRM Encryption設定 DRM設定時、FairPlay、Widevine/PlayReady DRMをサポート
drm.siteId	String	One Click Multi DRMサービスで作成した site id
drm.contentId	String	DRM Encryption適用対象コンテンツの固有 ID DRMパッケージングに使用され、英数字、記号の「-」(ハイフン)、「_」(アンダースコア)のみ使用して3~100文字以内で入力できます。

フィールド名

タイプ

説明

備考

channelName

String

channelId

String

instanceNo

String

channelStatus

String

CREATING、READY、PUBLISHING、DELETED、BLOCK、RESERVED、FORCE_BLOCK、FORCE_DELETED

VODチャンネルは RESERVED、PUBLISHINGの状態でのみ停止可能

cdn

Object

cdn.cdnType

String

GLOBAL_CDN、GLOBAL_EDGE

cdn.instanceNo

String

NO_CDNの場合は0

cdn.profileId

Integer

Global Edgeのプロファイル ID

NO_CDNの場合は0

cdn.statusName

String

CDNの状態

RUNNING、PUBLISHING、STOPPING、STOPPED、CREATING、CHANGING、CDN_NOT_FOUND

cdn.serviceName

String

CDN Service Name

NO_CDNの場合は""

cdn.cdnDomain

String

CDN Domain

NO_CDNの場合は""

qualitySetId

Integer

qualitySetName

String

outputProtocol

String

alertOn

Boolean

alertOptions

Object

totalPublishSeconds

Integer

createdTime

Integer

updatedTime

Integer

envType

String

DEV、STAGE、REAL

type

String

VOD

callbackEndpoint

String

scheduleList

Array

スケジュールが存在する場合にのみレスポンス

scheduleList.scheduleId

Integer

scheduleList.status

String

drmEnabledYn

Boolean

DRM Encryption設定の適用有無

drm

Object

Live Stationを利用した DRM Encryption設定
DRM設定時、FairPlay、Widevine/PlayReady DRMをサポート

drm.siteId

String

One Click Multi DRMサービスで作成した site id

drm.contentId

String

DRM Encryption適用対象コンテンツの固有 ID
DRMパッケージングに使用され、英数字、記号の「-」(ハイフン)、「_」(アンダースコア)のみ使用して3~100文字以内で入力できます。

例

リクエスト例

PUT /api/v2/vod/channels/ls-20200323114720-bMoDF/off HOST: livestation.apigw.ntruss.com Content-Type: application/json x-ncp-apigw-timestamp:1521787414578 x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M= x-ncp-region_code:KR

レスポンス例

HTTP/1.1 200 OK Server: nginx Date: Fri, 26 Feb 2021 09:53:32 GMT Content-Type: application/json;charset=utf-8 Connection: keep-alive Access-Control-Allow-Origin: * x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4 { "content": { "channelId": "ls-20200323114720-bMoDF", "channelName": "mychannel", "instanceNo": 1163899, "qualitySetId": 6, "qualitySetName": "360p-set", "outputProtocol": "HLS", "channelStatus": "BLOCK", "cdn": { "instanceNo": "1163900", "serviceName": "edge-ls-20200323114720-bMoDF", "statusName": "RUNNING", "cdnType": "GLOBAL_EDGE", "cdnDomain": "mycdn.edge.naverncp.com", "profileId": 299, "regionType": "KOREA" }, "alertOn": false, "alertOptions": { "alertChangeStatus": false }, "totalPublishSeconds": 21605, "createdTime": 1637234628000, "updatedTime": 1637729278000, "recentPublishTime": 1637235365000, "callbackEndpoint": "https://my-callback-endpoint", "envType": "REAL", "scheduleList": [ { "scheduleId": 10018, "status": "READY" } ], "drmEnabledYn": true, "drm": { "siteId": "drm-20231115142326-nHyNw", "contentId": "my-Test-Multidrm" } } }

チャンネルの停止

リクエスト

リクエストヘッダ

レスポンス

例

リクエスト例

レスポンス例

What's Next