Stop channel
- Print
- PDF
Stop channel
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
An API to suspend VOD channels of Live Station.
Requests
Caution
VOD channels can only be suspended when the status is RESERVED or PUBLISHING.
PUT https://livestation.apigw.ntruss.com/api/v2/vod/channels/{channelId}/off
Request headers
Header name | Requirement status | Description |
---|---|---|
x-ncp-apigw-timestamp | YES | It indicates the time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds, and the request is considered invalid if the time difference from the API Gateway server is 5 minutes or longerx-ncp-apigw-timestamp:{Timestamp} |
x-ncp-iam-access-key | YES | Value of access key ID issued in the NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | YES | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
Content-Type | YES | Specifies the request body content type as application/jsonContent-Type: application/json |
x-ncp-region_code | YES | Region code (KR) |
Response
Field name | Type | Description | Remarks |
---|---|---|---|
channelName | String | ||
channelId | String | ||
instanceNo | String | ||
channelStatus | String | CREATING, READY, PUBLISHING, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETED | VOD channels can only be suspended when the status is RESERVED or PUBLISHING |
cdn | Object | ||
cdn.cdnType | String | CDN_PLUS, GLOBAL_CDN, GLOBAL_EDGE | |
cdn.instanceNo | String | If NO_CDN, 0 | |
cdn.profileId | Integer | Profile ID of Global Edge | If NO_CDN, 0 |
cdn.statusName | String | RUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND | CDN status |
cdn.serviceName | String | CDN Service Name | If NO_CDN, "" |
cdn.cdnDomain | String | CDN Domain | If NO_CDN, "" |
qualitySetId | Integer | ||
qualitySetName | String | ||
outputProtocol | String | Default set: HLS | |
alertOn | Boolean | if alertOn == true, alertOptions should be set | |
alertOptions | Object | ||
totalPublishSeconds | Integer | ||
createdTime | Integer | ||
updatedTime | Integer | ||
envType | String | DEV, STAGE, REAL | |
type | String | VOD | |
callbackEndpoint | String | ||
scheduleList[] | Array | Responds only if schedule exists | |
scheduleList[].scheduleId | Integer | ||
scheduleList[].status | String | ||
drmEnabledYn | Boolean | Whether to apply DRM Encryption settings | |
drm | Object | DRM Encryption settings using Live Station When setting DRM, FairPlay and Widevine/PlayReady DRM are supported | |
drm.siteId | String | Site id created through One Click Multi DRM product | |
drm.contentId | String | Unique ID of content where DRM Encryption is applied Used for DRM packaging. You can enter 3 to 100 characters using English letters, numbers, hyphens (-), and underscores (_). |
Examples
Request example
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
Response example
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": "cdn-ls-20200323114720-bMoDF",
"statusName": "running",
"cdnType": "CDN_PLUS",
"cdnDomain": "mycdn.cdn.ntruss.com"
},
"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"
}
}
}
Was this article helpful?