채널 목록 조회

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

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

요청

GET https://livestation.apigw.ntruss.com/api/fin-v2/channels?pageSize={pageNo}&pageSizeNo={pageSizeNo}&channelStatus={channelStatus}&id={channelId}&channelName={channelName}

요청 파라미터

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

요청 헤더

헤더명	필수 여부	설명
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	리전 코드 (FKR)

응답

필드명	타입	설명	비고
channelId	String
channelName	String
instanceNo	String
qualitySetId	Integer
qualitySetName	String
outputProtocol	String
channelStatus	String	CREATING, READY, PUBLISH, DELETED, BLOCK, FORCE_BLOCK, FORCE_DELETED
isRecording	Boolean
useDvr	Boolean
immediateOnAir	Boolean
timemachineMin	Integer		단위 : Minute
cdn	Object
cdn.instanceNo	String		NO_CDN 이면 0
cdn.serviceName	String	CDN Service Name	NO_CDN 이면 ""
cdn.statusName	String	CDN 상태	NO_CDN 이면 ""
cdn.cdnType	String	CDN_PLUS
cdn.cdnDomain	String	CDN Domain	NO_CDN 이면 ""
snapshot	Object
snapshotId	Integer
record	Object
record.format	String	MP4,HLS,ALL
record.type	String	NO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD
record.bucketName	String
record.filePath	String
record.accessControl	String	PRIVATE, PUBLIC_READ
uploadPath	String	AUTO_UPLOAD 옵션일때 녹화 파일 업로드 경로
publishUrl	String
globalPublishUrl	String	해외 송출 지원을 위한 URL
streamKey	String
recentPublishStartTime	Integer
createdTime	Integer
alertOn	Boolean
alertOptions	Object
alertOptions.alertChangeStatus	Boolean
alertOptions.alertVodUploadFail	Boolean
alertOptions.alertReStreamFail	Boolean
totalPublishSeconds	Integer
envType	String	DEV, STAGE, REAL
callbackEndpoint	String
backupStreamKey	String	송출 이중화를 위한 백업 스트림키
isStreamFailOver	Boolean	송출 이중화 설정 적용 여부	true, false
origin	Object	CDN 연동을 위한 Live station 원본 정보
origin.originDomain	String	CDN 연동을 위한 Live station 원본 도메인
origin.originPath	String	CDN 연동을 위한 Live station 원본 상세 경로

예시

요청 예시

GET /api/fin-v2/channels?pageNo=1&pageSizeNo=2
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:FKR

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Sep 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-20200323114720-bMoDF",
            "channelName" : "mychannel",
            "instanceNo" : 1163899,
            "qualitySetId" : 6,
            "qualitySetName" : "360p-set",
            "outputProtocol" : "HLS, DASH",
            "channelStatus" : "READY",
            "isRecording" : false,
            "useDVR" : true,
            "immediateOnAir" : false,
            "timemachineMin" : 360,
            "cdn" : {
                  "instanceNo" : "1163900",
                  "serviceName" : "cdn-ls-20200323114720-bMoDF",
                  "statusName" : "running",
                  "cdnType" : "CDN_PLUS",
                  "cdnDomain" : "mycdn.cdn.ntruss.com"
            },
            "record": {
            "type": "AUTO_UPLOAD",
            "bucketName": "hls",
            "filePath": "/livestation",
            "format": "MP4",
            "accessControl": "PRIVATE"
        },
            "uploadPath": "/hls/livestation",
            "publishUrl": "rtmp://live-station-rtmp-url",
            "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
            "streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
            "totalPublishSeconds" : 0,
            "createdTime" : 1584931640000,
            "alertOn" : false,
            "alertOptions" : {
                  "alertChangeStatus" : false,
                  "alertVodUploadFail" : false,
                  "alertReStreamFail" : false
            },
            "callbackEndpoint": "https://my-callback-endpoint",
            "envType": "REAL"
      },
      {
            "channelId" : "ls-20200323114720-ascDF",
            "channelName" : "mychannel",
            "instanceNo" : 1163800,
            "qualitySetId" : 6,
            "qualitySetName" : "360p-set",
            "outputProtocol" : "HLS, DASH",
            "isRecording" : false,
            "useDVR" : true,
            "immediateOnAir" : false,
            "timemachineMin" : 360,
            "cdn" : {
                  "instanceNo" : "1163900",
                  "serviceName" : "cdn-ls-20200323114720-ascDF",
                  "statusName" : "running",
                  "cdnType" : "CDN_PLUS",
                  "cdnDomain" : "mycdn.cdn.ntruss.com"
            },
            "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
       },
            "publishUrl": "rtmp://live-station-rtmp-url",
            "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
            "streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
            "totalPublishSeconds" : 0,
            "createdTime" : 1584931640000,
            "alertOn" : false,
            "alertOptions" : {
                  "alertChangeStatus" : false,
                  "alertVodUploadFail" : false,
                  "alertReStreamFail" : false
            },
            "callbackEndpoint": "https://my-callback-endpoint",
            "envType": "REAL"
      }
    ],
    "total" : 2
}

이 문서가 도움이 되었습니까?

What's Next

채널 설정 수정

요청
응답
예시

태그