사이트 목록 조회

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

사이트 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/sites

요청 쿼리 파라미터

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

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

요청 헤더

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

요청 예시

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

curl --location --request GET 'https://multi-drm.apigw.ntruss.com/api/v1/sites?pageNo=1&pageSize=10' \
--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'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`success`	Boolean	-	API 처리 결과 `true` \| `false` `true`: 성공 `false`: 실패
`content`	Array	-	사이트 목록: content
`total`	Integer	-	전체 응답 수

`content`

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

필드	타입	필수 여부	설명
`disabled`	Boolean	-	Sub Account 비활성화 여부 `true` \| `false` `true`: 비활성 `false`: 활성
`siteId`	String	-	사이트 아이디
`siteName`	String	-	사이트 이름
`siteStatus`	String	-	사이트 상태 `CREATING` \| `READY` \| `RUNNING` \| `DELETED` `CREATING`: 생성 중 `READY`: 사용 가능 `RUNNING`: 사용 중 `DELETED`: 삭제
`siteEnabledYn`	Boolean	-	사이트 활성화 여부 `true` \| `false` `true`: 활성 `false`: 비활성
`policyId`	Integer	-	DRM 정책 아이디 `0`: Basic
`policyName`	String	-	정책 이름 `Basic` (기본값)
`fairPlayCert`	Object	-	FairPlay Streaming 인증 정보
`fairPlayCert.certFile`	String	-	FPS 인증서 Apple 개발자 포털에서 생성한 DER 또는 CER 파일 HTTP URL만 지원
`fairPlayCert.privateKey`	String	-	개인 키 PEM 파일 HTTP URL만 지원
`fairPlayCert.privateEncryptedString`	String	-	개인 키 파일을 열 수 있는 암호 문자열
`fairPlayCert.secretKey`	String	-	ASK(Application secret key) 문자열 FPS 인증서 생성 시 함께 획득
`statistics`	Object	-	사이트 통계 정보
`statistics.siteMontlyActiveUser`	Integer	-	월간 DRM 적용 콘텐츠를 이용한 사용자 수
`statistics.siteMontlyActiveLicense`	Integer	-	월간 활성화된 라이선스 수
`statistics.siteMontlyActiveDevice`	Integer	-	월간 DRM 적용 콘텐츠가 재생된 기기 수
`siteCreatedTime`	Integer	-	사이트 생성 일시(밀리초) Unix Timestamp 형식
`siteUpdatedTime`	Integer	-	사이트 수정 일시(밀리초) Unix Timestamp 형식

응답 상태 코드

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

응답 예시

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

{
    "success": true,
    "content": [
        {
            "disabled": false,
            "siteId": "drm-20250902164486-*****",
            "siteName": "myDrmSite000",
            "siteStatus": "READY",
            "siteEnabledYn": false,
            "policyId": 0,
            "policyName": "Basic",
            "fairPlayCert": {},
            "statistics": {
                "siteMontlyActiveUser": 0,
                "siteMontlyActiveDevice": 0,
                "siteMontlyActiveLicense": 0
            },
            "siteCreatedTime": 1756799065841,
            "siteUpdatedTime": 1756774819000
        },
        {
            "disabled": false,
            "siteId": "drm-20250903141775-*****",
            "siteName": "myDrmSite",
            "siteStatus": "READY",
            "siteEnabledYn": false,
            "policyId": 0,
            "policyName": "Basic",
            "fairPlayCert": {
                "certFile": "myFairPlayCert.cer",
                "privateKey": "myFairPlayCertPrivateKey.pem",
                "privateEncryptedString": "***********",
                "secretKey": "***********"
            },
            "statistics": {
                "siteMontlyActiveUser": 0,
                "siteMontlyActiveDevice": 0,
                "siteMontlyActiveLicense": 0
            },
            "siteCreatedTime": 1756876670519,
            "siteUpdatedTime": 1756844777000
        }
    ],
    "total": 2
}