채널 설정 수정
    • PDF

    채널 설정 수정

    • PDF

    기사 요약

    Live Station은 채널 설정을 수정 하기 위한 API를 제공합니다.

    요청

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

    요청 헤더

    헤더명필수 여부설명
    x-ncp-apigw-timestampYES1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYES네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2YESAccess Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    x-ncp-region_codeYES리전 코드 (KR)

    요청 바디

    필드명필수 여부타입제약 사항설명
    channelNameYesString최소 3글자 이상 최대 20자 문자까지 입력 가능
    특수 문자“_” 허용
    생성할 채널의 이름
    envTypeOptionalStringDEV, STAGE, REAL생성할 채널의 사용 구분을 위한 설정
    입력 하지 않을 경우 REAL 로 설정됨
    outputProtocolOptionalStringHLS / HLS,DASH / LL_HLS입력 하지 않을 경우 HLS 로 디폴트 셋팅
    HLS/HLS,DASH 프로토콜과 LL_HLS 프로토콜 간 상호 전환은 지원하지 않음.
    useDvrYesBooleantrue, false
    immediateOnAirYesBooleantrue, false송출과 동시에 녹화가 진행되는 자동 녹화 옵션
    timemachineMinYesInteger단위는 분(minutes) 이며 360 으로만 설정 가능녹화 시작 시점까지 영상을 되돌려 볼 수 있는 타임머신 기능 관련 옵션
    useDvr 이 true 일 경우 반드시 설정해야 함
    recordYesObject
    record.formatYesStringMP4,HLS,ALL버킷으로 자동 저장 되는 녹화 파일의 타입을 지정
    record.typeYesStringNO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD저장된 녹화 파일 업로드 타입을 지정
    "NO_RECORD" 로 설정시 녹화 기능 사용 불가
    record.bucketNameOptionalString자동 저장 기능을 통해 라이브 방송 종료 후 입력한 Bucket 에 녹화 파일이 자동 저장
    record.filePathOptionalString자동 저장 기능을 통해 라이브 방송 종료 후 지정한 filePath 에 녹화 파일이 자동 저장
    filePath 는 "/" 부터 시작 해야함
    record.accessControlOptionalStringPRIVATE, PUBLIC_READ자동 저장 기능을 통해 녹화 파일 업로드시 Object Storage Bucket 공개 범위를 지정하는 옵션
    Default: PRIVATE

    응답

    필드명타입설명비고
    channelIdString
    channelNameString
    instanceNoString
    qualitySetIdInteger
    qualitySetNameString
    outputProtocolString
    channelStatusStringCREATING, READY, PUBLISH, DELETED,BLOCK, FORCE_BLOCK, FORCE_DELETED
    isRecordingBoolean
    useDvrBoolean
    immediateOnAirBooleantrue, false
    timemachineMinInteger단위: Minute
    uploadPathStringAUTO_UPLOAD 옵션일때 녹화 파일 업로드 경로
    recordObject
    record.formatStringMP4,HLS,ALL
    record.typeStringNO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD
    record.bucketNameString
    record.filePathString
    record.accessControlStringPRIVATE, PUBLIC_READ
    cdnObject
    cdn.cdnTypeStringGLOBAL_CDN, GLOBAL_EDGE
    cdn.instanceNoStringNO_CDN 이면 0
    cdn.profileIdIntegerGlobal Edge 의 프로필 IDNO_CDN 이면 0
    cdn.statusNameStringCDN 상태RUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND
    cdn.serviceNameStringCDN Service NameNO_CDN 이면 ""
    cdn.cdnDomainStringCDN DomainNO_CDN 이면 ""
    publishUrlString
    globalPublishUrlString해외 송출 지원을 위한 URL
    streamKeyString
    recentPublishStartTimeInteger
    createdTimeInteger
    alertOnBoolean
    alertOptionsObject
    alertOptions.alertChangeStatusBoolean
    alertOptions.alertVodUploadFailBoolean
    alertOptions.alertReStreamFailBoolean
    totalPublishSecondsInteger
    envTypeStringDEV, STAGE, REAL
    callbackEndpointString
    backupStreamKeyString송출 이중화를 위한 백업 스트림키
    isStreamFailOverBoolean송출 이중화 설정 적용 여부true, false
    originObjectCDN 연동을 위한 Live station 원본 정보
    origin.originDomainStringCDN 연동을 위한 Live station 원본 도메인
    origin.originPathStringCDN 연동을 위한 Live station 원본 상세 경로
    drmEnabledYnBooleanDRM Encryption 설정 적용 유무
    drmObjectLive Station 을 활용한 DRM Encryption 설정
    drm.siteIdStringOne Click Multi DRM 상품을 통해 생성한 site id
    drm.contentIdStringDRM Encryption 을 적용할 콘텐츠의 고유 ID
    DRM 패키징을 위해 사용되며 최소 3글자 이상 영문/숫자 또는 ‘-'(하이픈), ‘_'(언더바) 포함 최대 100자 문자까지 입력 가능합니다.

    예시

    요청 예시

    PUT /api/v2/channels/ls-20210720153935-PjPQi
    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
    
    //Request body 
     {
      "channelName": "mychannel2",
      "envType": "DEV",
      "outputProtocol": "HLS",
      "immediateOnAir": false,
      "record": {
        "type": "NO_RECORD"
      },
      "timemachineMin": 360,
      "useDvr": true
    }
    

    응답 예시

    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-20210720153935-PjPQi",
        "channelName": "mychannel2",
        "instanceNo": 1163899,
        "qualitySetId": 6,
        "qualitySetName": "360p-set",
        "outputProtocol": "HLS,",
        "channelStatus": "READY",
        "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": "NO_RECORD"
        },
        "drm": {
          "contentId": "my-first-drm",
          "siteId": "drm-20231120182420-dPTGn"
        },
        "drmEnabledYn": true,
        "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
      }
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.