카테고리 상태 목록 조회
- 인쇄
- PDF
카테고리 상태 목록 조회
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
VOD Station은 카테고리들의 인코딩 상태 목록을 조회하기 위한 API를 제공합니다.
요청
GET https://vodstation.apigw.ntruss.com/api/v2/status
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| pageNo | No | Integer | - 요청할 페이지 번호 총 페이지 번호는 total/pageSizeNo | |
| pageSizeNo | No | Integer | 페이지당 카테고리 개수 | |
| workStartTimeTo | No | Integer | -인코딩 요청 조회 종료 시간 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 표현 | |
| workStartTimeFrom | No | Integer | - 인코딩 요청 조회 시작 시간 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 표현 |
카테고리 상태를 페이지로 나눠 조회하기
- 예: 인코딩 요청한 파일이 30개라면 페이지당 10개씩 노출되도록 카테고리 상태 조회
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=1&pageSizeNo=10
-> 총 30개 인코딩 파일을 페이지당 10개 단위로 요청하며, 첫 번째 페이지 요청
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=2&pageSizeNo=10
-> 총 30개 인코딩 파일을 페이지당 10개 단위로 요청하며, 두 번째 페이지 요청
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=3&pageSizeNo=10
-> 총 30개 인코딩 파일을 페이지당 10개 단위로 요청하며, 세 번째 페이지 요청
특정 시점에 요청한 인코딩 파일의 상태 조회하기
GET https://vodstation.apigw.ntruss.com/api/v2/status?workStartTimeTo=1631404800000&workStartTimeFrom=1631491200000
-> 2021년 9월 12일 오전 00:00:00 GMT 부터 2021년 9월 13일 오전 00:00:00 GMT 까지 요청한 인코딩 파일 상태 조회
요청 헤더
| 헤더명 | 설명 |
|---|---|
| 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[].categoryId | String | 카테고리 ID | |
| content[].categoryName | String | 카테고리 이름 | |
| content[].filePath | String | 입력 파일 이름 | |
| content[].outputType | Integer | 설정된 인코딩 설정에 따른 출력 타입 개수 | |
| content[].link | Boolean | - 출력 파일 다운로드 URL 출력 파일의 공개 범위가 "공개 안 함" 설정된 경우 접근이 불가능 할 수 있음 | |
| content[].outputTotalSize | String | 출력 파일 총 크기 (단위: byte) | |
| content[].lastWorkTime | Object | 마지막 작업 시간 | |
| content[].status | String | 인코딩 상태 | COMPLETE, WAITING, RUNNING, FAILURE, CANCELED |
| content[].percent | String | 인코딩 진행도 | |
| total | String | 전체 인코딩 수행 개수 |
예시
요청 예시
GET https://vodstation.apigw.ntruss.com/api/v2/status?pageNo=1&pageSizeNo=10
GET /api/v2/status?pageNo=1&pageSizeNo=10
HOST: vodstation.apigw.ntruss.com
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": [
{
"categoryId": 10019,
"categoryName": "test2",
"filePath": "SampleVideo_1280x720_5mb_auto_90fps_abr.mp4",
"outputType": "auto_90fps_abr",
"link": "https://kr.object.ncloudstorage.com/.../SampleVideo_1280x720_5mb_AVC_SD_1Pass_30fps.mp4",
"outputTotalSize": 81040256,
"lastWorkTime": "2021-09-14T15:49:12+0900",
"status": "COMPLETE",
"percent": 100
},
],
"total": 1
}
이 문서가 도움이 되었습니까?