Viewing channel event
- Print
- PDF
Viewing channel event
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
VOD Station provides an API to search events that occurred in channels.
Requests
GET https://vodstation.apigw.ntruss.com/api/v2/channels/{channelId}/events
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| pageNo | No | Integer | - Page number to request Total page number is total/pageSizeNo | |
| pageSizeNo | No | Integer | Number of events per page |
Search channel events by page
- Example: searching the channel list to view 10 events per page when 30 events have been created
GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=1&pageSizeNo=10
-> Request the first page from a total of 30 events, separated by 10 per page
GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=2&pageSizeNo=10
-> Request the second page from a total of 30 events, separated by 10 per page
GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=3&pageSizeNo=10
-> Request the third page from a total of 30 events, separated by 10 per page
Request headers
| Header name | Description |
|---|---|
| x-ncp-region_code | NAVER Cloud Platform's region code x-ncp_region_code:{Region Code} |
| x-ncp-apigw-timestamp | 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 greater than 5 minutes.x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Access key ID value issued by the NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the Access Key ID value and Secret Keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
Responses
| Field name | Type | Description | Remarks |
|---|---|---|---|
| content[] | Array | VOD Station OPEN API response object | |
| content[].time | String | Event occurred at | |
| content[].actionType | Object | Event action type | CREATE, START, STOP, DELETE |
| content[].requestType | Integer | Request type that triggered the action | MC(Console), API(OPENAPI), MCC(Media Connect Center) |
| content[].resultCode | String | Success status of the action | SUCCESS, FAILED |
| content[].messageCode | String | Event message code | |
| content[].message | Array | Event message details | |
| total | Integer | Total number of events that occurred in channel | |
| 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. Responds when an API Gateway error occurs. |
Examples
Request examples
GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events
GET /api/v2/channels/vs-20191227055342-vDVWH5l/events
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 examples
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": [
{
"time": 1577426040,
"actionType": "CREATE",
"requestType": "API",
"resultCode": "SUCCESS",
"messageCode": "CHANNEL_READY",
"message": "api-guide ready"
},
{
"time": 1577426022,
"actionType": "CREATE",
"requestType": "API",
"resultCode": "SUCCESS",
"messageCode": "CHANNEL_CREATING",
"message": "api-guide creating"
}
],
"total": 2
}
Was this article helpful?