채널 목록 조회
- 인쇄
- PDF
채널 목록 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VOD Station은 채널 목록을 조회하기 위한 API를 제공합니다.
요청
GET https://vodstation.apigw.ntruss.com/api/v2/channels
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| pageNo | No | Integer | 요청할 페이지 번호 총 페이지 번호는 total/pageSizeNo | |
| pageSizeNo | No | Integer | 페이지당 채널 개수 |
생성한 채널을 페이지로 나눠 조회하기
- <예시> 생성한 채널이 30개라면 페이지당 10개씩 노출되도록 채널 목록 조회
GET https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=10
-> 총 30개 채널을 페이지당 10개 단위로 요청하며, 첫 번째 페이지 요청
GET https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=2&pageSizeNo=10
-> 총 30개 채널을 페이지당 10개 단위로 요청하며, 두 번째 페이지 요청
GET https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=3&pageSizeNo=10
-> 총 30개 채널을 페이지당 10개 단위로 요청하며, 세 번째 페이지 요청
요청 헤더
| 헤더명 | 설명 |
|---|---|
| x-ncp-region_code | 네이버 클라우드 플랫폼 region code x-ncp_region_code:{Region Code} |
| x-ncp-apigw-timestamp | 1970년 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-v2 | Access Key ID 값과 Secret Key로 암호화한 서명x-ncp-apigw-signature-v2:{API Gateway Signature} |
응답
| 필드명 | 타입 | 설명 | 비고 |
|---|---|---|---|
| content[] | Array | VOD Station OPEN API 응답 객체 배열 | |
| content[].id | String | 생성된 채널의 ID | |
| content[].name | Object | 채널 이름 | |
| content[].channelStatus | Integer | 채널의 현재 상태 | CREATING, READY, STOPPING, STOPPED, TERMINATING, TERMINATED, FORCE_STOPPING, FORCE_STOPPED, FORCETERMINATING, FORCETERMINATED |
| content[].storageBucketName | String | 채널에 연동된 Object Storage 버킷 이름 | |
| content[].encryptedBucketName | String | 채널에 연동된 Object Storage 버킷의 암호화된 이름으로 재생 URL 생성시 사용 | |
| content[].segmentDuration | Integer | 채널의 segment 재생 길이(단위 : 초) | |
| content[].segmentDurationOption | String | 채널의 segment keyframe 정렬 옵션 | |
| content[].accessPrivateFiles | Boolean | 버킷 내 비공개 파일에 대한 VOD Station에서의 접근 제한 설정 | |
| content[].protocolList[] | Array(String) | 채널의 스트리밍 프로토콜 목록 | |
| content[].createTime | Integer | 채널의 생성 시작 시간 | |
| content[].readyTime | Integer | 채널의 생성 완료 시간 | |
| content[].cdnCreatedTime | Integer | 채널에 연동하여 자동 생성된 CDN의 생성 시간 | |
| content[].playUrl | String | CDN을 통한 재생 URL Template | |
| content[].cdnStatus | String | 채널에 연동된 CDN의 상태. 자동 생성하지 않으면 NOT_FOUND 로 노출 | |
| content[].cdnDomain | String | 자동 생성된 Global Edge 도메인 | |
| content[].cdnServiceName | String | 자동 생성된 Global Edge 서비스명 | |
| content[].cdn | Object | 자동 생성된 Global Edge 정보 | |
| content[].cdn.cdnType | String | 자동 생성된 CDN 타입 | |
| content[].cdn.cdnDomain | String | 자동 생성된 Global Eddge의 도메인 | |
| content[].cdn.cdnServiceName | String | 자동 생성된 Global Edge의 서비스명 | |
| content[].cdn.profileId | String | 자동 생성된 Global Edge의 프로필 아이디 | |
| content[].cdn.regionType | String | 자동 생성된 Global Edge 의 서비스 지역 | |
| content[].cdn.cdnInstanceNo | Integer | 자동 생성된 Global Edge 의 인스턴스 정보 | |
| content[].storageBucketStatus | String | 채널에 연동된 Object Storage 버킷의 상태 | |
| content[].originPath | String | 생성한 채널의 원본 경로로 별도 CDN 생성 시 참고 | |
| content[].encryptionList[] | Array | 채널의 미디어 보안 설정 | |
| content[].encryptionList[].protocol | String | 미디어 보안 대상 프로토콜 | |
| content[].encryptionList[].mediaEncryptionTypeCode | Integer | 미디어 보안 설정의 암호화 타입 1: AES-128 2: Sample-AES 3: CENC | |
| content[].encryptionList[].drmTypeCode | Intenger | 미디어 보안 설정의 DRM 타입 21: FairPlay 22: Widevine/PlayReady | |
| content[].encryptionList[].drmTypeName | String | 미디어 보안 설정의 DRM 타입 명 | |
| content[].encryptionList[].drmContentId | String | VOD Station에서 패키징시 요청할 Content ID | |
| content[].encryptionList[].systemIdList | Array(String) | VOD Station에서 패키징시 요청할 DRM System ID | |
| content[].encryptionList[].drmKeyUrl | String | VOD Station에서 패키징시 요청할 DRM CPIX API URL | |
| content[].drm | Object | VOD Station 을 활용한 DRM Encryption 설정 | |
| content[].drm.siteId | String | One Click Multi DRM 상품을 통해 생성한 site id | |
| content[].drm.contentId | String | DRM Encryption 을 적용할 콘텐츠의 고유 ID DRM 패키징을 위해 사용되며 최소 3글자 이상 영문/숫자 또는 ‘-'(하이픈), ‘_'(언더바) 포함 최대 100자 문자까지 입력 가능합니다. | |
| total | Integer | 총 채널의 수 | |
| error | Object | 오류 응답 코드 및 메시지 | |
| error.errorCode | Integer | 오류 응답 코드 | |
| error.message | String | 오류 응답 메시지 | |
| error.details | String | error message의 상세한 설명 api gateway 오류 발생 시 응답 |
예시
요청 예시
GET https://vodstation.apigw.ntruss.com/api/v2/channels
GET /api/v2/channels
HOST: vodstation.apigw.ntruss.com
x-ncp-region_code:KR
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": [
{
"id": "vs-20201112113327-Icwk9YO",
"name": "api-guide-drm",
"channelStatus": "RUNNING",
"storageBucketName": "vodstation-bucket",
"encryptedBucketName": "zz0G2Esbn14HUBlaiZSVkg__",
"segmentDuration": 5,
"segmentDurationOption": "BASIC",
"accessPrivateFiles": true,
"protocolList": [
"HLS",
"DASH"
],
"createTime": 1605148407,
"cdnCreatedTime": 1605148407,
"playUrl": "https://example.edge.navercorp.com/[protocol]/[Object Storage Bucket(encryption name)]/[path]/[video filename]/[manifest]",
"cdnStatus": "RUNNING",
"cdnDomain": "example.edge.naverncp.com",
"cdnServiceName": "vscdn-Icwk9YO",
"storageBucketStatus": "RUNNING",
"cdn": {
"cdnType": "GLOBAL_EDGE",
"cdnDomain": "example.edge.naverncp.com",
"cdnServiceName": "edge-vs-20230628185044-4HOrw8z",
"profileId": 681,
"regionType": "KOREA",
"cdnInstanceNo": 1000
},
"originPath": "vs-k1.video.media.ntruss.com/132/vs-20230628185044-4HOrw8z",
"drm": {
"siteId": "ABCD",
"contentId": "abc-2344-dfd"
},
"encryptList": [
{
"protocol": "DASH",
"mediaEncryptTypeCode": 3,
"mediaEncryptionTypeName": "AES-128",
"drmTypeCode": 22,
"drmTypeName": "Widevine/PlayReady",
"drmContentId": "openapi",
"systemIdList": [
"9A04F079-9840-4286-AB92-E65BE0885F95",
"EDEF8BA9-79D6-4ACE-A3C8-27DCD51D21ED"
],
"drmKeyUrl": "https://kms.example.com/cpix/token"
},
{
"protocol": "HLS",
"mediaEncryptTypeCode": 1,
"mediaEncryptionTypeName": "AES-128"
}
]
}
],
"total": 1
}
이 문서가 도움이 되었습니까?