채널 정지

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

Live Station 의 채널을 정지하는 API 입니다.

요청

PUT https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}/off

요청 헤더

헤더명	필수 여부	설명
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}`
Content-Type	YES	Request body content type을 application/json으로 지정 `Content-Type: application/json`
x-ncp-region_code	YES	리전 코드 (KR)

응답

필드명	타입	설명	비고
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
uploadPath	String	AUTO_UPLOAD 옵션일때 녹화 파일 업로드 경로
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
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 이면 ""
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
outputProtocol	String	HLS / HLS, DASH
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 원본 상세 경로
drmEnabledYn	Boolean	DRM Encryption 설정 적용 유무
drm	Object	Live Station 을 활용한 DRM Encryption 설정
drm.siteId	String	One Click Multi DRM 상품을 통해 생성한 site id
drm.contentId	String	DRM Encryption 을 적용할 콘텐츠의 고유 ID DRM 패키징을 위해 사용되며 최소 3글자 이상 영문/숫자 또는 ‘-'(하이픈), ‘_'(언더바) 포함 최대 100자 문자까지 입력 가능합니다.

예시

요청 예시

PUT /api/v2/channels/ls-20200323114720-bMoDF/off
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-20200323114720-bMoDF",
    "channelName": "mychannel",
    "instanceNo": 1163899,
    "qualitySetId": 6,
    "qualitySetName": "360p-set",
    "outputProtocol": "HLS, DASH",
    "channelStatus": "BLOCK",
    "isRecording": false,
    "useDVR": true,
    "immediateOnAir": false,
    "timemachineMin": 360,
    "cdn": {
      "instanceNo": "1163900",
      "serviceName": "edge-ls-20230914204831-1BRHO",
      "statusName": "RUNNING",
      "cdnType": "GLOBAL_EDGE",
      "cdnDomain": "mycdn.edge.naverncp.com",
      "profileId": 299,
      "regionType": "KOREA"
    },
    "record": {
      "type": "AUTO_UPLOAD",
      "bucketName": "hls",
      "filePath": "/livestation",
      "format": "MP4",
      "accessControl": "PRIVATE"
    },
    "drm": {
      "contentId": "my-first-drm",
      "siteId": "drm-20231120182420-dPTGn"
    },
    "drmEnabledYn": true,
    "uploadPath": "/hls/livestation",
    "publishUrl": "rtmp://live-station-rtmp-url",
    "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
    "streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
    "totalPublishSeconds": 0,
    "createdTime": 1584931640000,
    "recentPublishStartTime": 0,
    "alertOn": false,
    "alertOptions": {
      "alertChangeStatus": false,
      "alertVodUploadFail": false,
      "alertReStreamFail": false
    },
    "callbackEndpoint": "https://my-callback-endpoint",
    "envType": "REAL",
    "origin": {
      "originDomain": "ls-k1.video.media.ntruss.com",
      "originPath": "1"
    },
    "backupStreamKey": "lbuy4dcrxk2ctxs8uqxanpy833p08vvz?backup=true",
    "isStreamFailOver": true
  }
}

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

What's Next

채널 정지 해제

요청
응답
예시

태그