Remove channel suspension
    • PDF

    Remove channel suspension

    • PDF

    Article Summary

    An API to remove suspension of VOD channels of Live Station.

    Requests

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

    Request headers

    Header nameRequirement statusDescription
    x-ncp-apigw-timestampYESIt 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 longer
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYESValue of access key ID issued in the NAVER Cloud Platform portal
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2YESSignature encrypted with the access key ID value and secret key
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeYESSpecifies the request body content type as application/json
    Content-Type: application/json
    x-ncp-region_codeYESRegion code (KR)

    Response

    Field nameTypeDescriptionRemarks
    channelNameString
    channelIdString
    instanceNoString
    channelStatusStringCREATING, READY, PUBLISH, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETEDVOD channels can only be suspended when the status is RESERVED or PUBLISHING
    cdnObject
    cdn.cdnTypeStringCDN_PLUS, GLOBAL_CDN, GLOBAL_EDGE
    cdn.instanceNoStringIf NO_CDN, 0
    cdn.profileIdIntegerProfile ID of Global EdgeIf NO_CDN, 0
    cdn.statusNameStringRUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUNDCDN status
    cdn.serviceNameStringCDN Service NameIf NO_CDN, ""
    cdn.cdnDomainStringCDN DomainIf NO_CDN, ""
    qualitySetIdInteger
    qualitySetNameString
    outputProtocolStringDefault set: HLS
    alertOnBooleanif alertOn == true, alertOptions should be set
    alertOptionsObject
    alertOptions.alertChangeStatusBoolean
    totalPublishSecondsInteger
    createdTimeInteger
    updatedTimeInteger
    envTypeStringDEV, STAGE, REAL
    typeStringVOD
    callbackEndpointString
    scheduleList[]ArrayResponds only if schedule exists
    scheduleList[].scheduleIdInteger
    scheduleList[].statusString
    drmEnabledYnBooleanWhether to apply DRM Encryption settings
    drmObjectDRM Encryption settings using Live Station
    When setting DRM, FairPlay and Widevine/PlayReady DRM are supported
    drm.siteIdStringSite id created through One Click Multi DRM product
    drm.contentIdStringUnique 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
            },
            "callbackEndpoint": "https://my-callback-endpoint",
            "envType": "REAL",
            "scheduleList": [
               {
                  "scheduleId": 10018,
                  "status": "FINISH"
               }
            ],
            "drmEnabledYn": true,
            "drm": {
                "siteId": "drm-20231115142326-nHyNw",
                "contentId": "my-Test-Multidrm"
            }
        }
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.