MD Navercorp table

T-Updated on 17 Apr 2025
T-Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Greetings

VOD Station provides an API to restart stopped channels.

Request

PUT https://vodstation.apigw.ntruss.com/api/v2/channels/{channelId}/start

Request headers

Header name	Description
x-ncp-region_code	NAVER Cloud Platform Region code `x-ncp_region_code:{Region Code}`
x-ncp-apigw-timestamp	It indicates the elapsed time in milliseconds since January 1, 1970 00:00:00 UTC. Request is considered invalid if the timestamp differs from the current time by more than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued on NAVER Cloud Platform portal `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with the access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`

Response

Field name	Type	Description	Remarks
content	Object	VOD Station open API response object
content.id	String	ID of the created channel
content.name	Object	Channel name
content.channelStatus	Integer	Channel's current status	CREATING, READY, STOPPING, STOPPED, TERMINATING, TERMINATED, FORCE_STOPPING, FORCE_STOPPED, FORCETERMINATING, FORCETERMINATED
content.storageBucketName	String	Name of the Object Storage bucket integrated with the channel
content.encryptedBucketName	String	Encrypted name of the Object Storage bucket integrated with the channel, used when creating the playback URL
content.accessPrivateFiles	Boolean	Set access restrictions in VOD Station for private files in the bucket
content.segmentDuration	Integer	Segment duration of the channel (unit: second)
content.segmentDurationOption	String	Channel's segment keyframe sorting options
content.protocolList[]	Array(String)	List of streaming protocols of the channel
content.createTime	Integer	The time channel creation started
content.readyTime	Integer	The time channel creation was completed
content.cdnCreatedTime	Integer	The time when the CDN was automatically created in integration with the channel
content.playUrl	String	CDN-based playback URL template
content.cdnStatus	String	Status of the CDN integrated with the channel. Displayed as not found if the CDN was not automatically created
content.cdnDomain	String	Auto-generated Global Edge's domain
content.cdnServiceName	String	Auto-generated Global Edge's service name
content.cdn	Object	Auto-generated Global Edge information
content.cdn.cdnType	String	Auto-generated CDN type
content.cdn.cdnDomain	String	Auto-generated Global Edge's domain
content.cdn.cdnServiceName	String	Auto-generated Global Edge's service name
content.cdn.profileId	String	Auto-generated Global Edge's profile ID
content.cdn.regionType	String	Auto-generated Global Edge's service area
content.cdn.cdnInstanceNo	Integer	Auto-generated Global Edge's instance information
content.storageBucketStatus	String	Status of the Object Storage bucket integrated with the channel
content.originPath	String	Source path of the created channel, which is referred to when an independent CDN is created
content.encryptionList[]	Array	Media security settings of the channel
content.encryptionList[].protocol	String	Media security target protocol
content.encryptionList[].mediaEncryptionTypeCode	Integer	Media security setting's encryption type 1: AES-128 2: Sample-AES 3: CENC
content.encryptionList[].drmTypeCode	Intenger	Media security setting's DRM type 21: FairPlay 22: Widevine/PlayReady
content.encryptionList[].drmTypeName	String	Name of the media security setting's DRM type
content.encryptionList[].drmContentId	String	Content ID to be requested when packaging from VOD Station
content.encryptionList[].systemIdList	Array(String)	DRM system ID to be requested when packaging from VOD Station
content.encryptionList[].drmKeyUrl	String	DRM CPIX API URL to be requested when packaging from VOD Station
content.drm	Object	DRM encryption settings using VOD Station
content.drm.siteId	String	Site id created with One Click Multi DRM product
content.drm.contentId	String	Unique ID of the content to apply DRM encryption to It is used for DRM packaging and can be at least 3 characters and up to 100 characters, including English letter, numbers, "-" (hyphen), and "_" (underscore)
error	Object	Error response code and message
error.errorCode	String	Error response code
error.message	String	Error response message
error.details	String	Detailed description of the error message It responds when an error occurs in the API Gateway

Examples

Request example

PUT https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20201112113327-Icwk9YO/start

PUT /api/v2/channels/vs-20191227055342-vDVWH5l/start
HOST: vodstation.apigw.ntruss.com
x-ncp-region_code:KR
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=

Response example

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
  "content": {
    "id": "vs-20201112113327-Icwk9YO",
    "name": "api-guide-drm",
    "channelStatus": "STARTING",
    "storageBucketName": "vodstation-bucket",
    "encryptedBucketName": "zz0G2Esbn14HUBlaiZSVkg__",
    "segmentDuration": 5,
    "segmentDurationOption": "BASIC",
    "accessPrivateFiles": true,
    "protocolList": [
      "HLS",
      "DASH"
    ],
    "createTime": 1605148407,
    "cdnCreatedTime": 1605148407,
    "playUrl": "https://example.edge.naverncp.com/[protocol]/[Object Storage Bucket(encryption name)]/[path]/[video filename]/[manifest]",
    "cdnStatus": "STOPPED",
    "cdnDomain": "example.cdn.ntruss.com",
    "cdnServiceName": "vscdn-Icwk9YO",
    "storageBucketStatus": "RUNNING",
    "cdn": {
      "cdnType": "GLOBAL_EDGE",
      "cdnDomain": "example.edge.navercorp.com",
      "cdnServiceName": "edge-vscdn-Icwk9YO",
      "profileId": 554,
      "regionType": "KOREA",
      "cdnInstanceNo": 1351
    },
    "originPath": "vs-k1.video.media.ntruss.com/132/vs-20201112113327-Icwk9YO",
    "drm": {
      "siteId": "ABCD",
      "contentId": "abc-2344-dfd"
    },
    "encryptList": [
      {
        "protocol": "DASH",
        "mediaEncryptTypeCode": 3,
        "mediaEncryptionTypeName": "AES-128",
        "drmTypeCode": 22,
        "drmTypeName": "Widevine/PlayReady",
        "drmContentId": "openapi",
        "systemIdList": [
          "9A04F079-9840-4286-AB92-E65BE0885F95",
          "EDEF8BA9-79D6-4ACE-A3C8-27DCD51D21ED"
        ],
        "drmKeyUrl": "https://kms.example.com/cpix/token"
      },
      {
        "protocol": "HLS",
        "mediaEncryptTypeCode": 1,
        "mediaEncryptionTypeName": "AES-128"
      }
    ]
  }
}

Was this article helpful?

What's Next

Index1

Table of contents

Request
Response
Examples