채널 목록 조회
    • PDF

    채널 목록 조회

    • PDF

    기사 요약

    Live Station은 VOD 채널의 목록을 조회하기 위한 API를 제공합니다.

    요청

    GET https://livestation.apigw.ntruss.com/api/fin-v2/vod/channels?pageNo={pageNo}&pageSizeNo={pageSizeNo}
    

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    pageNoNoInteger제약 없음조회 할 페이지 인덱스
    pageSizeNoNoInteger1~100목록 조회시 포함될 채널 수
    예시) 생성된 채널이 60개일때, pageSizeNo 30 이라면 페이지당 30개씩 채널 목록 조회

    요청 헤더

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

    응답

    필드명타입설명비고
    channelNameString
    channelIdString
    instanceNoString
    channelStatusStringCREATING, READY, PUBLISHING, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETEDVOD 채널은 RESERVED, PUBLISHING 상태일때만 정지 가능
    cdnObject
    cdn.cdnTypeStringCDN_PLUS
    cdn.instanceNoStringNO_CDN 이면 0
    cdn.statusNameStringCDN 상태NO_CDN 이면 ""
    cdn.serviceNameStringCDN Service NameNO_CDN 이면 ""
    cdn.cdnDomainStringCDN DomainNO_CDN 이면 ""
    qualitySetIdInteger
    qualitySetNameString
    outputProtocolString
    alertOnBoolean
    alertOptionsObject
    alertOptions.alertChangeStatusBoolean
    totalPublishSecondsInteger
    createdTimeInteger
    updatedTimeInteger
    envTypeStringDEV, STAGE, REAL
    typeStringVOD
    callbackEndpointString
    scheduleListArray스케줄이 존재할때만 응답
    scheduleList.scheduleIdInteger
    scheduleList.statusString

    예시

    요청 예시

    GET /api/fin-v2/vod/channels
    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
    

    응답 예시

    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": [
        {
          "channelId": "ls-20211122214005-DMOTD",
          "channelName": "myChannel1",
          "instanceNo": 2042924,
          "qualitySetId": 4,
          "qualitySetName": "720p-set",
          "outputProtocol": "HLS",
          "status": "READY",
          "cdn": {
            "instanceNo": "1541959",
            "serviceName": "cdn-ls-20201204112949-D7RTL",
            "statusName": "running",
            "cdnType": "CDN_PLUS",
            "cdnDomain": "mycdn.cdn.ntruss.com",
          },
          "totalPublishSeconds": 5405,
          "createdTime": 1637584805000,
          "updatedTime": 1637591709000,
          "alertOn": false,
          "recentPublishTime": 1637586303000,
          "alertOptions": {
            "alertChangeStatus": false
          },
          "callbackEndpoint": ""https://my-callback-endpoint",
          "envType": "REAL",
          "type": "VOD",
          "scheduleList": [
             {
                "scheduleId": 10049,
                "status": "FINISH"
             }
          ]
        },
        {
          "channelId": "ls-20211117184137-8rRjJ",
          "channelName": "myChannel2",
          "instanceNo": 2029554,
          "qualitySetId": 4,
          "qualitySetName": "720p-set",
          "outputProtocol": "HLS",
          "status": "READY",
          "cdn": {
            "instanceNo": "1541959",
            "serviceName": "cdn-ls-20201204112949-D7RTL",
            "statusName": "running",
            "cdnType": "CDN_PLUS",
            "cdnDomain": "mycdn.cdn.ntruss.com",
          },
          "totalPublishSeconds": 21604,
          "createdTime": 1637142098000,
          "updatedTime": 1637309411000,
          "alertOn": false,
          "recentPublishTime": 1637287806000,
          "alertOptions": {
            "alertChangeStatus": false
          },
          "callbackEndpoint": ""https://my-callback-endpoint",
          "envType": "DEV",
          "type": "VOD",
          "scheduleList": [
             {
                "scheduleId": 10019,
                "status": "FINISH"
             }
          ],
          "audioOnly": false
        }
      ],
      "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.