플레이어 목록 조회

Prev Next

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

플레이어 목록을 조회합니다.

요청

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

메서드 URI
GET /api/v1/players

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
page_no Integer Optional 페이지 번호
  • 1~1000 (기본값: 1)
page_size Integer Optional 페이지당 항목 수
  • 10~1000 (기본값: 10)
sort_type String Optional 생성일 기준 정렬 순서
  • desc (기본값) | asc
    • desc: 내림차순
    • asc: 오름차순

요청 예시

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

curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code String - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.list Array - 플레이어 목록: list
result.total Integer - 응답 결과 수
result.page_no Integer - 페이지 번호
result.page_size Integer - 페이지당 항목 수
result.page_count Integer - 전체 페이지 수
result.pricing String - 요금제
  • free | pay
    • free: 무료
    • pay: 유료

list

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

필드 타입 필수 여부 설명
no Integer - 플레이어 번호
name String - 플레이어 이름
version String - 플레이어 SDK 버전
access_key String - 플레이어 Access Key
updated_at String - 플레이어 수정 일시
  • ISO 8601 형식
created_at String - 플레이어 생성 일시
  • ISO 8601 형식

응답 상태 코드

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

응답 예시

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

{
    "code": "200",
    "message": "ok",
    "result": {
        "list": [
            {
                "no": 6284,
                "name": "player001",
                "version": "latest",
                "access_key": "5a2f************************1830",
                "updated_at": "2025-08-12T02:17:10.000+00:00",
                "created_at": "2025-08-12T02:17:10.000+00:00"
            },
            {
                "no": 6159,
                "name": "player000",
                "version": "1.1.3",
                "access_key": "7848************************102d",
                "updated_at": "2025-08-12T02:23:31.000+00:00",
                "created_at": "2025-05-27T05:34:37.000+00:00"
            }
        ],
        "total": 2,
        "page_no": 1,
        "page_size": 10,
        "page_count": 1,
        "pricing": "pay"
    }
}