카테고리 파일 추가

VOD Station은 카테고리에 인코딩 파일을 추가하기 위한 API를 제공합니다.

요청

PUT https://vod-station.apigw.gov-ntruss.com/api/v2/category/{categoryId}/add-files

요청 헤더

헤더명	설명
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-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 바디

API 요청 시 필드명의 대소문자 구분이 필요합니다.

필드명	필수 여부	타입	제약 사항	기본 값	설명
bucketName	Yes	String			입력 파일이 업로드 되어있는 버킷 이름, httpDownload URL 혹은 bucketName, filePath 를 입력해야합니다.
pathList	Yes	Array(String)	100개 이하 입력 파일 지원		파일명을 포함한 입력 파일의 상세 경로, httpDownload URL 혹은 bucketName, filePath 를 입력해야 합니다.
httpDownloadUrlList	Yes	Array(String)	100개 이하 입력 파일 지원, http url 형식, AVI, MOV, MP4, MP3, 3GP, MPG, MPEG, M4V, VOB, WMV, ASF, MKV, FLV, WEBM, GIF, AV1, MXF 확장자만 입력받음		파일명을 포함한 입력 파일의 상세 경로, httpDownload URL 혹은 bucketName, filePath 를 입력해야합니다.
notificationUrl	No	String			입력 파일에 대한 Callback URL 설정 (Overwrite Category notificationUrl Field)
output	No	Object			입력 파일에 대한 출력 설정 (Overwrite Category output Field)
output.bucketName	Yes	String			출력 버킷 이름
output.filePath	Yes	String			출력 파일을 업로드 할 상세 경로
output.thumbnailBucketName	Optional	String	입력하지 않을 시 카테고리 설정을 따름		썸네일 출력 버킷 이름
output.thumbnailFilePath	Optional	String	입력하지 않을 시 카테고리 설정을 따름 최소 1자, 최대 256자까지 입력 (영문, 숫자, < > : " / \ ? * % 제외 특수문자 허용)		썸네일 출력 파일을 업로드 할 상세 경로
output.accessControl	No	String	PUBLIC_READ, PRIVATE	PRIVATE	출력 파일의 공개 범위
output.thumbnailAccessControl	No	String	PUBLIC_READ, PRIVATE	PRIVATE	출력 썸네일의 공개 범위
output.withoutCategoryName	No	Boolean	true, false	false	Output 출력 경로에 카테고리 명의 폴더 생성 유무
setAdvancedOptions	No	Boolean	true, false	false	고급 설정 별도 설정 여부
advancedOptions	No	Object		NULL	고급 설정
advancedOptions.trimming	No	Object		NULL	출력 파일 트리밍 설정
advancedOptions.trimming.startTimeCode	Yes	String	포맷: "HH:MM:SS.S"		- 트리밍 시작 시점 타임코드 포맷에 맞춰 값 입력
advancedOptions.trimming.endTimeCode	Yes	String	포맷: "HH:MM:SS.S", startTimeCode보다 작은 값 입력 불가		- 트리밍 종료 시점 타임코드 포맷에 맞춰 값 입력
advancedOptions.imageOverlay	No	Object		NULL	이미지 오버레이 설정
advancedOptions.imageOverlay.input	Yes	Object			입력 이미지
advancedOptions.imageOverlay.input.bucketName	Yes	String			입력 이미지가 업로드 되어있는 버킷 이름
advancedOptions.imageOverlay.input.filePath	Yes	String			파일명을 포함한 입력 이미지의 상세 경로
advancedOptions.imageOverlay.position	Yes	Object			삽입할 이미지 위치 설정
advancedOptions.imageOverlay.position.x	Yes	Integer			x 축 위치
advancedOptions.imageOverlay.position.y	Yes	Integer			y 축 위치
advancedOptions.imageOverlay.size	Yes	Obejct			삽입할 이미지 크기 설정
advancedOptions.imageOverlay.size.width	Yes	Integer			이미지 너비
advancedOptions.imageOverlay.size.height	Yes	Integer			이미지 높이

응답

필드명	타입	설명	비고
content[]	Array(Object)	VOD Station OPEN API 응답 객체
content[].id	Integer	파일 인코딩 작업 ID
content[].bucketName	String	입력 파일이 업로드 되어있는 버킷 이름
content[].pathList	Array(String)	파일명을 포함한 입력 파일의 상세 경로
content[].httpDownloadUrl	Array(String)	외부로부터 다운로드 받을 HTTP URL
content[].status	String	파일 인코딩 상태	COMPLETE, WAITING, RUNNING, FAILURE, CANCELED
content[].notificationUrl	String	Callback URL 설정
content[].output	Object	출력 설정
content[].output.bucketName	String	출력 버킷 이름
content[].output.filePath	String	입력 파일을 업로드 할 상세 경로
content[].output.thumbnailBucketName	String	썸네일 출력 버킷 이름
content[].output.thumbnailFilePath	String	썸네일 출력 출력 파일 업로드 상세경로
content[].output.accessControl	String	출력 파일의 공개 범위
content[].output.thumbnailAccessControl	String	출력 썸네일의 공개 범위
content[].output.withoutCategoryName	Boolean	Output 출력 경로에 카테고리 명의 폴더 생성 유무
content[].advancedOptions	Object	고급 설정
content[].advancedOptions.trimming	Object	출력 파일 트리밍 설정
content[].advancedOptions.trimming.startTimeCode	String	트리밍 시작 시점
content[].advancedOptions.trimming.endTimeCode	String	트리밍 종료 시점
content[].advancedOptions.imageOverlay	Object	이미지 오버레이 설정
content[].advancedOptions.imageOverlay.input	Object	입력 이미지
content[].advancedOptions.imageOverlay.input.bucketName	String	입력 이미지가 업로드 되어있는 버킷 이름
content[].advancedOptions.imageOverlay.input.filePath	String	입력 이미지의 상세 경로
content[].advancedOptions.imageOverlay.position	Object	삽입할 이미지 위치 설정
content[].advancedOptions.imageOverlay.position.x	Integer	x축 위치
content[].advancedOptions.imageOverlay.position.y	Integer	y축 위치
content[].advancedOptions.imageOverlay.size	Obejct	삽입할 이미지 크기 설정
content[].advancedOptions.imageOverlay.size.width	Integer	이미지 너비
content[].advancedOptions.imageOverlay.size.height	Integer	이미지 높이

예시

요청 예시

PUT https://vod-station.apigw.gov-ntruss.com/api/v2/category/10095/add-files

PUT /api/v2/category/10095/add-files
HOST: vod-station.apigw.gov-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==

{
  "bucketName": "vs-input",
  "pathList": [
    "SampleVideo_1280x720_5mb.mp4", "/1-path/SampleVideo_1920x1080_5m.mp4"
  ]
}

응답 예시

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": 10240,
      "bucketName": "vs-input",
      "filePath": "SampleVideo_1280x720_5mb.mp4",
      "status": "WAITING"
    },
    {
      "id": 10241,
      "bucketName": "vs-input",
      "filePath": "/1-path/SampleVideo_1920x1080_5m.mp4",
      "status": "WAITING"
    }
  ]
}