채널 목록 조회

Prev Next

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

요청

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

요청 파라미터

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

요청 헤더

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

응답

필드명 타입 설명 비고
channelName String
channelId String
instanceNo String
channelStatus String CREATING, READY, PUBLISHING, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETED VOD 채널은 RESERVED, PUBLISHING 상태일때만 정지 가능
snapshot Object
snapshotId Integer
cdn Object
cdn.cdnType String GLOBAL_CDN, GLOBAL_EDGE
cdn.instanceNo String NO_CDN 이면 0
cdn.profileId Integer Global Edge 의 프로필 ID NO_CDN 이면 0
cdn.statusName String CDN 상태 RUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND
cdn.serviceName String CDN Service Name NO_CDN 이면 ""
cdn.cdnDomain String CDN Domain NO_CDN 이면 ""
qualitySetId Integer
qualitySetName String
outputProtocol String
alertOn Boolean
alertOptions Object
alertOptions.alertChangeStatus Boolean
totalPublishSeconds Integer
createdTime Integer
updatedTime Integer
envType String DEV, STAGE, REAL
type String VOD
callbackEndpoint String
scheduleList Array 스케줄이 존재할때만 응답
scheduleList.scheduleId Integer
scheduleList.status String
drmEnabledYn Boolean DRM Encryption 설정 적용 유무
drm Object Live Station 을 활용한 DRM Encryption 설정
DRM 설정시 FairPlay, Widevine/PlayReady DRM 지원
drm.siteId String One Click Multi DRM 상품을 통해 생성한 site id
drm.contentId String DRM Encryption 을 적용할 콘텐츠의 고유 ID
DRM 패키징을 위해 사용되며 최소 3글자 이상 영문/숫자 또는 ‘-'(하이픈), ‘_'(언더바) 포함 최대 100자 문자까지 입력 가능합니다.

예시

요청 예시

GET /api/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": "edge-ls-20201204112949-D7RTL",
        "statusName": "RUNNING",
        "cdnType": "GLOBAL_EDGE",
        "cdnDomain": "mycdn.edge.naverncp.com",
        "profileId": 299,
        "regionType": "KOREA"
      },
      "totalPublishSeconds": 5405,
      "createdTime": 1637584805000,
      "updatedTime": 1637591709000,
      "alertOn": false,
      "recentPublishTime": 1637586303000,
      "alertOptions": {
        "alertChangeStatus": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "REAL",
      "type": "VOD",
      "drmEnabledYn": true,
      "drm": {
        "siteId": "drm-20231115142326-nHyNw",
        "contentId": "my-Test-Multidrm"
      },
      "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": "edge-ls-20201204112949-D7RTL",
        "statusName": "RUNNING",
        "cdnType": "GLOBAL_EDGE",
        "cdnDomain": "mycdn.edge.naverncp.com",
        "profileId": 299,
        "regionType": "KOREA"
      },
      "totalPublishSeconds": 21604,
      "createdTime": 1637142098000,
      "updatedTime": 1637309411000,
      "alertOn": false,
      "recentPublishTime": 1637287806000,
      "alertOptions": {
        "alertChangeStatus": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "DEV",
      "type": "VOD",
      "drmEnabledYn": true,
      "drm": {
        "siteId": "drm-20231115142326-nHyNw",
        "contentId": "my-Test-Multidrm"
      },
      "scheduleList": [
        {
          "scheduleId": 10019,
          "status": "FINISH"
        }
      ],
      "audioOnly": false
    }
  ],
  "total": 2
}