Edit schedule
    • PDF

    Edit schedule

    • PDF

    Article Summary

    An API to edit the VOD schedule created in Live Station.

    Caution

    The following are the cautions for editing VOD schedules.

    • You can only edit the schedule when the VOD channel status is RESERVED.
    • Schedule start time is requested based on KST (UTC+9).

    Requests

    PUT https://livestation.apigw.ntruss.com/api/v2/vod/schedule/{scheduleId}
    

    Request headers

    Header nameRequiredDescription
    x-ncp-apigw-timestampYESTime elapsed since January 1, 1970 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference compared to the API Gateway server is 5 minutes or longer
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYESAccess key ID value issued from 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}
    x-ncp-region_codeYESRegion code (KR)

    Request bodies

    Field nameRequiredTypeService limitsDescription
    startTimeOptionalIntegerTime earlier than the request time cannot be entered
    Minimum input time: current request time + time after 10 minutes
    Maximum input time: current request time + 14 days
    Start time to stream the entered VOD
    Start time format: yyyyMMddHHmmss
    Based on KST (UTC+9)
    vodListOptionalArrayOnly mp4 file extension is allowed
    Up to 50 videos can be entered
    vodList.bucketNameOptionalStringBucket name of the Object Storage where the video to be streamed is stored
    vodList.filePathOptionalStringFilePath of the Object Storage where the video to be streamed is stored
    filePaths must start with "/"

    Responses

    Field nameTypeDescriptionNote
    scheduleIdInteger
    channelIdStringScheduled VOD Channel ID
    createdTimeTimestampSchedule creation time (epoch time)
    startTimeTimestampStart time for the first video to be streamed (epoch time)
    endTimeTimestampEstimated end time of the streaming (epoch time)
    updatedTimeTimestamp
    statusStringSchedule statusCREATING,PROCESSING,PROCESSING_FAIL,UPDATING,READY,FINISH,DELETED
    vodListArray

    Examples

    Request examples

    PUT /api/v2/vod/schedule/10053
    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
    
    // Request body (case 1. editing both the start time and the video to be streamed)
    {
      "startTime": "20211124002500",
      "vodList": [
        {
          "bucketName": "myBucket",
          "filePath": "/myFile.mp4"
        },
        {
          "bucketName": "myBucket2",
          "filePath": "/mp4/myFile2.mp4"
        },
        {
          "bucketName": "myBucket2",
          "filePath": "/mp4/myFile3.mp4"
        }
      ]
    }
    
    // Request body (case 2. editing only the start time)
    {
      "startTime": "20211126002500"
    }
    
    

    Response examples

    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": {
        "scheduleId": 10053,
        "channelId": "ls-20211122220557-mUv3r",
        "createdTime": 1637711621000,
        "startTime": 1637679145000,
        "endTime": 1637683800000,
        "updatedTime": 1637679495873,
        "status": "UPDATING",
        "vodList": [
          "/myBucket/myFile.mp4",
          "/mp4/myFile2.mp4",
          "/mp4/myFile3.mp4"
        ]
      }
    }
    
    

    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.