Edit schedule
- Print
- PDF
Edit schedule
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The API that can change VOD schedules created in Live Station.
Notes for editing a VOD schedule
- Schedules can only be edited when the VOD channel status is RESERVED.
- The schedule start time (startTime) is requested based on KST (UTC+9).
Request
PUT https://livestation.apigw.ntruss.com/api/v2/vod/schedule/{scheduleId}
Request header
| 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 if the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalidx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | YES | Access key ID value issued on 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} |
| x-ncp-region_code | YES | Region code (KR) |
Request body
| Field name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| startTime | Optional | Integer | Can't input a time that is earlier than the time of request Minimum input time: Current request time + after 10 minutes Maximum input time: Current request time + 14 days | Start time for streaming input VOD Start time format: yyyymmddhhss Based on KST (UTC+9) |
| vodList[] | Optional | Array | Only the .mp4 extension is supported Up to 50 videos can be input | |
| vodList[].bucketName | Optional | String | Name of Object Storage bucket where the video to stream is stored | |
| vodList[].filePath | Optional | String | Object Storage's filePath where the video to stream is stored filePaths must start with "/" |
Response
| Field name | Type | Description | Remarks |
|---|---|---|---|
| scheduleId | Integer | ||
| channelId | String | VOD channel ID to which schedule is linked | |
| createdTime | Timestamp | Schedule creation time (epoch time) | |
| startTime | Timestamp | Time when first video will be streamed (epoch time) | |
| endTime | Timestamp | Estimated streaming end time (epoch time) | |
| updatedTime | Timestamp | ||
| status | String | Schedule status | CREATING,PROCESSING,PROCESSING_FAIL,UPDATING,READY,FINISH,DELETED |
| vodList | String[] |
Example
Request example
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. When editing both the start time and the video to stream)
{
"startTime": "20211124002500",
"vodList": [
{
"bucketName": "myBucket",
"filePath": "/myFile.mp4"
},
{
"bucketName": "myBucket2",
"filePath": "/mp4/myFile2.mp4"
},
{
"bucketName": "myBucket2,
"filePath": "/mp4/myFile3.mp4"
}
]
}
//Request body (Case 2. When editing the start time only)
{
"startTime": "20211126002500"
}
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": {
"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?