채널 이벤트 조회
    • PDF

    채널 이벤트 조회

    • PDF

    기사 요약

    VOD Station은 채널에서 발생한 이벤트를 조회하기 위한 API를 제공합니다.

    요청

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

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    pageNoNoInteger-요청할 페이지 번호
    총 페이지 번호는 total/pageSizeNo
    pageSizeNoNoInteger페이지당 이벤트 개수

    채널의 이벤트를 페이지로 나눠 조회하기

    • 예: 발생한 이벤트가 30개라면 페이지당 10개씩 노출되도록 이벤트 목록 조회
    GET https://vodstation.apigw.fin-ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=1&pageSizeNo=10
    -> 총 30개 이벤트를 페이지당 10개 단위로 요청하며, 첫 번째 페이지 요청
    
    GET https://vodstation.apigw.fin-ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=2&pageSizeNo=10
    -> 총 30개 이벤트를 페이지당 10개 단위로 요청하며, 두 번째 페이지 요청
    
    GET https://vodstation.apigw.fin-ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=3&pageSizeNo=10
    -> 총 30개 이벤트를 페이지당 10개 단위로 요청하며, 세 번째 페이지 요청
    

    요청 헤더

    헤더명설명
    x-ncp-region_code네이버 클라우드 플랫폼 region code
    x-ncp_region_code:{Region Code}
    x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2Access Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}

    응답

    필드명타입설명비고
    content[]ArrayVOD Station OPEN API 응답 객체
    content[].timeString이벤트 발생 시간
    content[].actionTypeObject이벤트 동작 타입CREATE, START, STOP, DELETE
    content[].requestTypeIntegeraction을 유발 한 요청 타입MC(Console), API(OPENAPI), MCC(Media Connect Center)
    content[].resultCodeStringaction의 성공 여부SUCCESS, FAILED
    content[].messageCodeString이벤트 메시지 코드
    content[].messageArray이벤트 상세 메시지
    totalInteger채널에서 발생한 이벤트의 총 갯수
    errorObject오류 응답 코드 및 메시지
    error.errorCodeString오류 응답 코드
    error.messageString오류 응답 메시지
    error.detailsStringerror message의 상세한 설명. api gateway 오류 발생 시 응답.

    예시

    요청 예시

    GET https://vodstation.apigw.fin-ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events
    
    GET /api/v2/channels/vs-20191227055342-vDVWH5l/events
    HOST: vodstation.fin-apigw.ntruss.com
    x-ncp-region_code:FKR
    x-ncp-apigw-timestamp:1521787414578
    x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
    x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
    

    응답 예시

    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
    }
    

    이 문서가 도움이 되었습니까?

    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.