카테고리 목록 조회
- 인쇄
- PDF
카테고리 목록 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VOD Station은 카테고리 목록을 조회하기 위한 API를 제공합니다.
요청
GET https://vod-station.apigw.gov-ntruss.com/api/v2/category
요청 파라미터
파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
---|---|---|---|---|
pageNo | No | Integer | - 요청할 페이지 번호 총 페이지 번호는 total/pageSizeNo | |
pageSizeNo | No | Integer | 페이지당 카테고리 개수 |
생성한 카테고리를 페이지로 나눠 조회하기
- 예: 생성한 카테고리가 30개라면 페이지당 10개씩 노출되도록 카테고리 목록 조회
GET https://vod-station.apigw.gov-ntruss.com/api/v2/category?pageNo=1&pageSizeNo=10
→ 총 30개 카테고리를 페이지당 10개 단위로 요청하며, 첫 번째 페이지 요청
GET https://vod-station.apigw.gov-ntruss.com/api/v2/category?pageNo=2&pageSizeNo=10
→ 총 30개 카테고리를 페이지당 10개 단위로 요청하며, 두 번째 페이지 요청
GET https://vod-station.apigw.gov-ntruss.com/api/v2/category?pageNo=3&pageSizeNo=10
→ 총 30개 카테고리를 페이지당 10개 단위로 요청하며, 세 번째 페이지 요청
요청 헤더
헤더명 | 설명 |
---|---|
x-ncp-region_code | 네이버 클라우드 플랫폼 region code x-ncp_region_code:{Region Code} |
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} |
응답
필드명 | 타입 | 설명 | 비고 |
---|---|---|---|
error | Object | 요청 실패 시 응답 오류 응답 코드 및 메시지 | |
error.code | Integer | 오류 응답 코드 | |
error.message | String | 오류 응답 메시지 | |
content[] | Array(Object) | VOD Station OPEN API 응답 객체 | |
content[].id | String | 생성된 카테고리의 ID | |
content[].name | String | 카테고리 이름 | |
content[].encodingOptions[] | Array(Integer) | 인코딩 옵션 ID | |
content[].encodingOptionTemplateId | Integer | 인코딩 템플릿 ID | |
content[].thumbnail | Boolean | 썸네일 추출 설정 | |
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[].status | String | 카테고리 상태 | CREATED, DELETED, RUNNING |
content[].createTime | Integer | 카테고리 생성 시간 | |
content[].updateTime | Integer | 카테고리 수정 시간 | |
content[].disabled | Boolean | subaccount 제공 필드 해당 리소스가 subaccount에서 활성 여부 | |
content[].inputTotal | Integer | 입력 파일 총 개수 | |
content[].lastWorkStart | Integer | 마지막 작업 시간 | |
content[].outputTotal | Integer | 출력 파일 총 개수 | |
content[].outputTotalSize | Integer | 출력 파일 총 크기 (단위: byte) | |
content[].outputType | Integer | 설정된 인코딩 설정에 따른 출력 타입 개수 | |
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 | 이미지 높이 | |
total | Integer | 총 카테고리 개수 |
예시
요청 예시
GET https://vod-station.apigw.gov-ntruss.com/api/v2/category
GET /api/v2/category
HOST: vod-station.apigw.gov-ntruss.com
x-ncp-region_code:KR
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M==
응답 예시
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": [
{
"disabled": false,
"id": 10095,
"name": "3type-basic-category",
"thumbnail": false,
"output": {
"bucketName": "vs-output",
"filePath": "/"
},
"createTime": 1631594152000,
"updateTime": 1631594152000,
"status": "CREATED",
"outputType": 3,
"encodingOptions": [
1,
2,
3
]
}
],
"total": 1
}
이 문서가 도움이 되었습니까?