채널 목록 조회

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

채널 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v2/channels

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	페이지 번호 1~N (기본값: 1)
`pageSizeNo`	Integer	Optional	페이지당 항목 수 1~N (기본값: 20)

요청 예시

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

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

`content`

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

필드	타입	필수 여부	설명
`disabled`	Boolean	-	Sub Account 비활성화 여부 `true` \| `false` `true`: 비활성 `false`: 활성
`id`	String	-	채널 아이디
`name`	String	-	채널 이름
`channelStatus`	String	-	채널 상태 `CREATING` \| `READY` \| `STOPPING` \| `STOPPED` \| `TERMINATING` \| `TERMINATED` \| `FORCE_STOPPING` \| `FORCE_STOPPED` \| `FORCETERMINATING` \| `FORCETERMINATED` `CREATING`: 생성 중 `READY`: 운영 중 `STOPPING`: 정지 중 `STOPPED`: 정지 완료 `TERMINATING`: 삭제 중 `TERMINATED`: 삭제 완료 `FORCE_STOPPING`: 강제 정지 중 `FORCE_STOPPED`: 강제 정지 완료 `FORCETERMINATING`: 강제 삭제 중 `FORCETERMINATED`: 강제 삭제 완료
`storageBucketName`	String	-	채널이 스트리밍할 영상이 저장되어 있는 버킷 이름
`segmentDuration`	Integer	-	세그먼트당 재생 시간(초)
`protocolList`	Array	-	스트리밍 프로토콜 목록 `HLS` \| `DASH`
`createTime`	Integer	-	채널 생성 시작 일시(초) Unix Timestamp 형식
`readyTime`	Integer	-	채널 생성 완료 일시(초) Unix Timestamp 형식
`cdnCreatedTime`	Integer	-	채널에 연동하여 자동 생성된 CDN의 생성 일시(초) Unix Timestamp 형식
`stopTime`	Integer	-	채널 정지 일시(초) Unix Timestamp 형식 `channelStatus`이 `STOPPED`(정지 완료)인 경우, 표시
`playUrl`	String	-	CDN을 통한 재생 URL 템플릿
`cdnStatus`	String	-	채널에 연동된 CDN의 상태 자동 생성하지 않으면 `NOT_FOUND`로 표시
`cdnDomain`	String	-	자동 생성된 Global Edge 도메인
`cdnServiceName`	String	-	자동 생성된 Global Edge 서비스 이름
`storageBucketStatus`	String	-	채널에 연동된 Object Storage 버킷의 상태
`originPath`	String	-	생성한 채널의 원본 경로 별도 CDN 생성 시 사용
`encryptList`	Array	-	채널의 콘텐츠 보호 설정 정보: encryptList
`accessPrivateFiles`	Boolean	-	버킷 내 비공개 파일 접근 제한 설정 여부 `true` \| `false` (기본값) `true`: 허용 `false`: 제한 허용 시 비공개 파일도 스트리밍 가능
`encryptedBucketName`	String	-	채널에 연동된 버킷의 암호화된 이름 재생 URL 생성 시 사용
`segmentDurationOption`	String	-	세그먼트 분할 방식 설정 `BASIC` \| `VARIABLE` `BASIC`: `segmentDuration` 설정 간격으로 일정하게 세그먼트 생성 `VARIABLE`: 모든 세그먼트가 키 프레임(keyframe)으로 시작하도록 세그먼트 생성 `VARIABLE` 옵션을 선택한 경우, `segmentDuration` 값과 실제 생성된 세그먼트 재생 시간에 차이 발생 가능성 존재
`cdn`	Object	-	자동 생성된 CDN(Global Edge) 정보
`cdn.cdnType`	String	-	CDN 유형 `GLOBAL_EDGE` (유효 값)
`cdn.cdnDomain`	String	-	자동 생성된 Global Edge 도메인
`cdn.cdnServiceName`	String	-	자동 생성된 Global Edge의 서비스 이름
`cdn.profileId`	Integer	-	자동 생성된 Global Edge의 프로필 아이디
`cdn.regionType`	String	-	자동 생성된 Global Edge의 서비스 지역
`cdn.cdnInstanceNo`	Integer	-	자동 생성된 Global Edge의 인스턴스 정보

`encryptList`

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

필드	타입	필수 여부	설명
`drmContentId`	String	Optional	DRM 콘텐츠 아이디 DRM Key 요청 시 해당 값을 포함해 요청하며, 라이선스(License) 발급 시 필요
`drmKeyUrl`	String	-	DRM Key URL DRM 제공사의 CPIX API URL VOD Station은 공식적으로 Inka Pallyacon DRM의 CPIX v1 API와의 연동을 지원
`systemIdList`	Array	-	DRM 시스템 아이디 DRM 시스템 고유 식별자
`drmTypeCode`	Integer	Optional	DRM 유형 `21` \| `22` `21`: FairPlay `22`: Widevine/PlayReady
`drmTypeName`	String	-	DRM 유형 이름
`protocol`	String	-	설정된 프로토콜 `HLS` \| `DASH` `HLS`: FairPlay/Media Encryption `DASH`: Widevine/PlayReady
`mediaEncryptTypeCode`	Integer	Optional	설정된 Media Encryption(HLS AES-128) 코드 설정 `1` \| `2` \| `3` `1`: AES-128 `2`: Sample-AES `3`: CENC
`mediaEncryptionTypeName`	String	-	설정된 Media Encryption(HLS AES-128) 타입 이름 `AES-128` \| `Sample-AES` \| `CENC`

응답 상태 코드

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

응답 예시

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

{
    "content": [
        {
            "disabled": false,
            "id": "vs-20250821095732-*******",
            "name": "ch-media-encrypt",
            "channelStatus": "READY",
            "storageBucketName": "station-000",
            "segmentDuration": 10,
            "protocolList": [
                "HLS"
            ],
            "createTime": 1755737852,
            "readyTime": 1755737880,
            "cdnCreatedTime": 1755737852,
            "playUrl": "https://cpzplvi******.edge.naverncp.com/[protocol]/[Object Storage Bucket(encryption name)]/[path]/[video filename]/[manifest]",
            "cdnStatus": "RUNNING",
            "cdnDomain": "cpzplvi******.edge.naverncp.com",
            "cdnServiceName": "edge-vs-20250821095732-*******",
            "storageBucketStatus": "RUNNING",
            "originPath": "vs2-k1.video.media.ntruss.com/2706412/vs-20250821095732-*******",
            "encryptList": [
                {
                    "protocol": "HLS",
                    "mediaEncryptTypeCode": 1
                }
            ],
            "accessPrivateFiles": true,
            "encryptedBucketName": "*****VzPmKvIthkozoufHw__",
            "segmentDurationOption": "BASIC",
            "cdn": {
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "cpzplvi******.edge.naverncp.com",
                "cdnServiceName": "edge-vs-20250821095732-*******",
                "profileId": ****,
                "regionType": "KOREA",
                "cdnInstanceNo": *****
            }
        }
    ],
    "total": 1
}