채널 목록 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

라이브 채널 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v2/channels

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
pageNo Integer Optional 페이지 번호
  • 1~N
pageSizeNo Integer Optional 페이지당 항목 수
  • 1~100
channelStatus String Optional 채널 상태로 필터링
  • CREATING | READY | PUBLISHING | DELETED | BLOCK | FORCE_BLOCK | FORCE_DELETED
    • CREATING: 생성 중
    • READY: 준비
    • PUBLISHING: 송출 중
    • DELETED: 반납
    • BLOCK: 정지
    • FORCE_BLOCK: 강제 정지
    • FORCE_DELETED: 사용 불가
id String Optional 채널 아이디로 필터링
  • 전체 또는 부분 일치하는 값 표시
channelName String Optional 채널 이름으로 필터링
  • 전체 또는 부분 일치하는 값 표시

요청 헤더

Live Station API에서 공통으로 사용하는 헤더에 대한 정보는 Live Station 요청 헤더를 참조해 주십시오.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=1&channelName=chan' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
content Array - 채널 목록: content
total Integer - 전체 응답 수

content

content에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
channelId String - 채널 아이디
channelName String - 채널 이름
instanceNo Integer - 채널 인스턴스 번호
qualitySetId Integer - 화질 설정 아이디
qualitySetName String - 화질 설정 이름
outputProtocol String - Output Protocol
channelStatus String - 채널 상태
  • CREATING | READY | PUBLISHING | DELETED | BLOCK | FORCE_BLOCK | FORCE_DELETED
    • CREATING: 생성 중
    • READY: 준비
    • PUBLISHING: 송출 중
    • DELETED: 반납
    • BLOCK: 정지
    • FORCE_BLOCK: 강제 정지
    • FORCE_DELETED: 사용 불가
isRecording Boolean - 녹화 여부
  • true | false
    • true: 녹화 중
    • false: 녹화 중 아님
useDVR Boolean - 타임머신 설정 여부
  • true | false
    • true: 설정
    • false: 설정 안 함
immediateOnAir Boolean - 송출 즉시 자동 녹화 설정 여부
  • true | false
    • true: 자동
    • false: 수동
timemachineMin Integer - 타임머신 허용 범위(분)
cdn Object - CDN 설정
cdn.instanceNo String - CDN 인스턴스 아이디
cdn.serviceName String - CDN 서비스 이름
cdn.statusName String - CDN 상태
  • RUNNING | PUBLISHING | STOPPING | STOPPED | CREATING | CHANGING | CDN_NOT_FOUND
    • RUNNING: 운영 중
    • PUBLISHING: 배포 중
    • STOPPING: 정지 중
    • STOPPED: 정지
    • CREATING: 생성 중
    • CHANGING: 변경 중
    • CDN_NOT_FOUND: CDN을 찾을 수 없음
cdn.cdnType String - CDN 유형
  • GLOBAL_CDN | GLOBAL_EDGE
cdn.cdnDomain String - CDN 서비스 도메인
cdn.profileId Integer - Global Edge 프로필 아이디
cdn.regionType String - Global Edge 서비스 지역
streamKey String - 메인 스트림 키
publishUrl String - 기본 송출 URL
globalPublishUrl String - 해외 송출 URL
totalPublishSeconds Integer - 채널 사용 시간(초)
createdTime Integer - 채널 생성 일시(밀리초)
  • Unix Timestamp 형식
alertOn Boolean - 이벤트 알람 설정 여부
  • true | false
    • true: 설정
    • false: 설정 안 함
recentPublishStartTime Integer - 최근 송출 시작 일시(밀리초)
  • Unix Timestamp 형식
  • 최초 송출 전인 경우, 미표시
alertOptions Object - 이벤트 알람 설정
alertOptions.alertChangeStatus Boolean - 채널 상태 변경 알람 적용 여부
  • true | false
    • true: 적용
    • false: 적용 안 함
alertOptions.alertVodUploadFail Boolean - 녹화 파일 업로드 실패 알람 적용 여부
  • true | false
    • true: 적용
    • false: 적용 안 함
alertOptions.alertReStreamFail Boolean - 동시 송출 릴레이 실패 알람 적용 여부
  • true | false
    • true: 적용
    • false: 적용 안 함
alertOptions.reStreamFailThreshold Integer - 알람 발생 조건(기준 횟수)
alertOptions.alertStreamFailOver Boolean - 메인 스트림 전환 알람 적용 여부
  • true | false
    • true: 적용
    • false: 적용 안 함
callbackEndpoint String - 콜백 엔드포인트 URL
  • 유효 값 존재 시 표시
envType String - 채널 타입
  • DEV | STAGE | REAL
uploadPath String - 녹화 파일 업로드 경로
  • record.typeAUTO_UPLOAD인 경우, 표시
record Object - 녹화 저장 정보
record.type String - 녹화 저장 설정
  • NO_RECORD | AUTO_UPLOAD | MANUAL_UPLOAD
    • NO_RECORD: 녹화 안 함
    • AUTO_UPLOAD: 자동 저장
    • MANUAL_UPLOAD: 임시 저장
record.bucketName String - 녹화 파일 저장 버킷 이름
  • record.typeAUTO_UPLOAD인 경우, 표시
record.filePath String - 저장 상세 경로
  • record.typeAUTO_UPLOAD인 경우, 표시
record.format String - 자동 저장 녹화 타입
  • MP4 | HLS | ALL
record.accessControl String - 녹화 파일 저장 버킷 공개 범위
  • PRIVATE | PUBLIC_READ
    • PRIVATE: 비공개
    • PUBLIC_READ: 공개
  • record.typeAUTO_UPLOAD인 경우, 표시
snapshot Object - 스냅샷 정보
  • 방송 송출 중 스냅샷을 생성한 경우에만 표시
snapshot.snapshotId Integer - 스냅샷 아이디
origin Object - 원본 정보
origin.originDomain String - 원본 도메인
origin.originPath String - 원본 경로
backupStreamKey String - 백업 스트림 키
  • 송출 이중화 설정 시 표시
isStreamFailOver Boolean - 송출 이중화 설정 여부
  • true | false
    • true: 사용
    • false: 사용 안 함
drmEnabledYn Boolean - Multi DRM 사용 여부
  • true | false
    • true: 사용
    • false: 사용 안 함
drm Object - Multi DRM 설정
  • drmEnabledYntrue인 경우, 하위 정보 표시
drm.siteId String - 사이트 아이디
drm.contentId String - 콘텐츠 아이디

응답 상태 코드

Live Station API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Live Station 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "content": [
        {
            "channelId": "ls-20250813******-SkhxV",
            "channelName": "mychannel",
            "instanceNo": 10*****39,
            "qualitySetId": 2584,
            "qualitySetName": "ll-audio-only",
            "outputProtocol": "LL_HLS",
            "channelStatus": "READY",
            "isRecording": false,
            "useDVR": true,
            "immediateOnAir": true,
            "timemachineMin": 360,
            "cdn": {
                "instanceNo": "11565",
                "serviceName": "edge-ls-20250813******-SkhxV",
                "statusName": "RUNNING",
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "cj***********.edge.naverncp.com",
                "profileId": 4207,
                "regionType": "KOREA"
            },
            "streamKey": "y******************************n",
            "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
            "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
            "totalPublishSeconds": 237,
            "createdTime": 1755070375000,
            "alertOn": true,
            "recentPublishStartTime": 1755128792000,
            "alertOptions": {
                "alertChangeStatus": true,
                "alertVodUploadFail": true,
                "alertReStreamFail": false,
                "reStreamFailThreshold": 2,
                "alertStreamFailOver": true
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "DEV",
            "uploadPath": "/mybucket/",
            "record": {
                "type": "AUTO_UPLOAD",
                "bucketName": "mybucket",
                "filePath": "/",
                "format": "MP4",
                "accessControl": "PRIVATE"
            },
            "origin": {
                "originDomain": "*****.video.media.ntruss.com",
                "originPath": "2*****5"
            },
            "backupStreamKey": "y******************************************e",
            "isStreamFailOver": true,
            "drmEnabledYn": false
        }
    ],
    "total": 2
}