카테고리 목록 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

카테고리 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v2/category

요청 헤더

VOD Station API에서 공통으로 사용하는 헤더에 대한 정보는 VOD Station 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
pageNo Integer Optional 페이지 번호
  • 1~N (기본값: 1)
pageSizeNo Integer Optional 페이지당 항목 수
  • 1~N (기본값: 20)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/category' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
content Array - 카테고리 목록: content
total Integer - 전체 응답 수

content

content에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
disabled Boolean - Sub Account 비활성화 여부
  • true | false
    • true: 비활성
    • false: 활성
id Integer - 카테고리 아이디
name String - 카테고리 이름
thumbnail Boolean - 섬네일 추출 설정 여부
  • true | false
    • true: 추출
    • false: 추출 안 함
notificationUrl String - 콜백(Callback) URL
output Object - 출력 설정 정보
output.bucketName String - 출력 파일을 저장할 버킷 이름
output.filePath String - 출력 파일을 저장할 상세 경로
output.accessControl String - 출력 파일 공개 범위
output.thumbnailAccessControl String - 추출 섬네일 공개 범위
output.thumbnailBucketName String - 추출 섬네일을 저장할 버킷 이름
output.thumbnailFilePath String - 추출 섬네일을 저장할 상세 경로
lastWorkStart Integer - 마지막 작업 시작 시간(밀리초)
  • Unix Timestamp 형식
createTime Integer - 카테고리 생성 일시(밀리초)
  • Unix Timestamp 형식
updateTime Integer - 카테고리 수정 일시(밀리초)
  • Unix Timestamp 형식
status String - 카테고리 상태
  • CREATED | DELETED | RUNNING
    • CREATED: 생성 완료
    • DELETED: 삭제 완료
    • RUNNING: 사용 중
outputTotalSize Integer - 출력 파일 총 크기(Byte)
outputTotal Integer - 전체 출력 파일 수
inputTotal Integer - 전체 입력 파일 수
outputType Integer - 인코딩 설정에 따른 출력 타입 수
advancedOptions Object - 고급 설정 정보
advancedOptions.trimming Object - 출력 파일 트리밍(재생 구간) 설정
advancedOptions.trimming.startTimeCode String - 트리밍 시작 시점(HH:MM:SS.S)
advancedOptions.trimming.endTimeCode String - 트리밍 종료 시점(HH:MM:SS.S)
advancedOptions.imageOverlay Object - 이미지 오버레이(삽입) 설정
advancedOptions.imageOverlay.input Object - 이미지 설정 정보
advancedOptions.imageOverlay.input.bucketName String - 이미지가 저장되어 있는 버킷 이름
advancedOptions.imageOverlay.input.filePath String - 파일명을 포함한 이미지의 상세 경로
advancedOptions.imageOverlay.size Object - 이미지 크기 정보
advancedOptions.imageOverlay.size.width Integer - 이미지 너비(픽셀)
advancedOptions.imageOverlay.size.height Integer - 이미지 높이(픽셀)
advancedOptions.imageOverlay.position Object - 삽입할 이미지 위치 설정
advancedOptions.imageOverlay.position.x Integer - x축 위치(픽셀)
advancedOptions.imageOverlay.position.y Integer - y축 위치(픽셀)
encodingOptions Array - 인코딩 옵션 아이디
encodingOptionTemplateId Integer - 인코딩 템플릿 아이디

응답 상태 코드

VOD Station API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 VOD Station 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "content": [
        {
            "disabled": false,
            "id": *****,
            "name": "VOD-Category",
            "thumbnail": true,
            "notificationUrl": "https://example.com/vodstation/callback",
            "output": {
                "bucketName": "station-000",
                "filePath": "/",
                "accessControl": "PUBLIC_READ",
                "thumbnailAccessControl": "PUBLIC_READ",
                "thumbnailBucketName": "station-000",
                "thumbnailFilePath": "/thumbnail"
            },
            "lastWorkStart": 1755576724000,
            "createTime": 1755569623000,
            "updateTime": 1755569623000,
            "status": "CREATED",
            "outputTotalSize": 3421908,
            "outputTotal": 3,
            "inputTotal": 1,
            "outputType": 3,
            "advancedOptions": {
                "trimming": {
                    "startTimeCode": "00:00:00.0",
                    "endTimeCode": "00:08:00.9"
                },
                "imageOverlay": {
                    "input": {
                        "bucketName": "station-000",
                        "filePath": "/VODStation.png"
                    },
                    "size": {
                        "width": 50,
                        "height": 50
                    },
                    "position": {
                        "x": 50,
                        "y": 50
                    }
                }
            },
            "encodingOptions": [
                1,
                2,
                3
            ],
            "encodingOptionTemplateId": 1
        }
    ],
    "total": 1
}