카테고리 목록 조회
    • PDF

    카테고리 목록 조회

    • PDF

    기사 요약

    VOD Station은 카테고리 목록을 조회하기 위한 API를 제공합니다.

    요청

    GET https://vod-station.apigw.gov-ntruss.com/api/v2/category
    

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    pageNoNoInteger- 요청할 페이지 번호
    총 페이지 번호는 total/pageSizeNo
    pageSizeNoNoInteger페이지당 카테고리 개수

    생성한 카테고리를 페이지로 나눠 조회하기

    • 예: 생성한 카테고리가 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-timestamp1970년 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-v2Access Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}

    응답

    필드명타입설명비고
    errorObject요청 실패 시 응답
    오류 응답 코드 및 메시지
    error.codeInteger오류 응답 코드
    error.messageString오류 응답 메시지
    content[]Array(Object)VOD Station OPEN API 응답 객체
    content[].idString생성된 카테고리의 ID
    content[].nameString카테고리 이름
    content[].encodingOptions[]Array(Integer)인코딩 옵션 ID
    content[].encodingOptionTemplateIdInteger인코딩 템플릿 ID
    content[].thumbnailBoolean썸네일 추출 설정
    content[].notificationUrlStringCallback URL 설정
    content[].outputObject출력 설정
    content[].output.bucketNameString출력 버킷 이름
    content[].output.filePathString출력 파일을 업로드 할 상세 경로
    content[].output.thumbnailBucketNameString썸네일 출력 버킷 이름
    content[].output.thumbnailFilePathString썸네일 출력 출력 파일 업로드 상세경로
    content[].output.accessControlString출력 파일의 공개 범위
    content[].output.thumbnailAccessControlString출력 썸네일의 공개 범위
    content[].statusString카테고리 상태CREATED, DELETED, RUNNING
    content[].createTimeInteger카테고리 생성 시간
    content[].updateTimeInteger카테고리 수정 시간
    content[].disabledBooleansubaccount 제공 필드
    해당 리소스가 subaccount에서 활성 여부
    content[].inputTotalInteger입력 파일 총 개수
    content[].lastWorkStartInteger마지막 작업 시간
    content[].outputTotalInteger출력 파일 총 개수
    content[].outputTotalSizeInteger출력 파일 총 크기 (단위: byte)
    content[].outputTypeInteger설정된 인코딩 설정에 따른 출력 타입 개수
    content[].advancedOptionsObject고급 설정
    content[].advancedOptions.trimmingObject출력 파일 트리밍 설정
    content[].advancedOptions.trimming.startTimeCodeString트리밍 시작 시점
    content[].advancedOptions.trimming.endTimeCodeString트리밍 종료 시점
    content[].advancedOptions.imageOverlayObject이미지 오버레이 설정
    content[].advancedOptions.imageOverlay.inputObject입력 이미지
    content[].advancedOptions.imageOverlay.input.bucketNameString입력 이미지가 업로드 되어있는 버킷 이름
    content[].advancedOptions.imageOverlay.input.filePathString입력 이미지의 상세 경로
    content[].advancedOptions.imageOverlay.positionObject삽입할 이미지 위치 설정
    content[].advancedOptions.imageOverlay.position.xIntegerx축 위치
    content[].advancedOptions.imageOverlay.position.yIntegery축 위치
    content[].advancedOptions.imageOverlay.sizeObejct삽입할 이미지 크기 설정
    content[].advancedOptions.imageOverlay.size.widthInteger이미지 너비
    content[].advancedOptions.imageOverlay.size.heightInteger이미지 높이
    totalInteger총 카테고리 개수

    예시

    요청 예시

    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
    }
    

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

    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.