MENU
      Viewing channel event
        • PDF

        Viewing channel event

        • PDF

        Article summary

        VOD Station provides an API to search events that occurred in channels.

        Requests

        GET https://vodstation.apigw.ntruss.com/api/v2/channels/{channelId}/events
        HTTP

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        pageNoNoInteger- Page number to request
        Total page number is total/pageSizeNo
        pageSizeNoNoIntegerNumber 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
        Plain text

        Request headers

        Header nameDescription
        x-ncp-region_codeNAVER Cloud Platform's region code
        x-ncp_region_code:{Region Code}
        x-ncp-apigw-timestampIt 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-keyAccess key ID value issued by the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the Access Key ID value and Secret Key
        x-ncp-apigw-signature-v2:{API Gateway Signature}

        Responses

        Field nameTypeDescriptionRemarks
        content[]ArrayVOD Station OPEN API response object
        content[].timeStringEvent occurred at
        content[].actionTypeObjectEvent action typeCREATE, START, STOP, DELETE
        content[].requestTypeIntegerRequest type that triggered the actionMC(Console), API(OPENAPI), MCC(Media Connect Center)
        content[].resultCodeStringSuccess status of the actionSUCCESS, FAILED
        content[].messageCodeStringEvent message code
        content[].messageArrayEvent message details
        totalIntegerTotal number of events that occurred in channel
        errorObjectError response code and message
        error.errorCodeStringError response code
        error.messageStringError response message
        error.detailsStringDetailed 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=
        HTTP

        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
        }
        HTTP

        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.