API v2.0 가이드 - NHN Cloud 사용자 가이드

Content Delivery > CDN > API v2.0 가이드

NHN Cloud CDN에서 제공하는 Public API v2.0을 설명합니다.

API 공통 정보

도메인

이름	도메인
CDN Public API 도메인	https://kr1-cdn.api.nhncloudservice.com

사전 준비

API를 사용하려면 앱 키(Appkey)와 보안 키(SecretKey)가 필요합니다. 앱 키와 보안 키는 콘솔 오른쪽 위의 URL & Appkey 메뉴에서 확인할 수 있습니다.

요청 공통 정보

요청 헤더

이름	설명
Authorization	콘솔에서 발급받은 보안 키(SecretKey)

Path 파라미터

모든 API는 앱 키를 path 파라미터로 지정해야 합니다. * 예) /v2.0/appKeys/{appKey}/distributions

이름	설명
appKey	콘솔에서 발급받은 앱 키(Appkey)

응답 공통 정보

헤더

모든 API 요청에 대해서 200 OK로 응답합니다. 자세한 응답 결과는 다음의 예와 같이 응답 본문의 헤더를 참고합니다.

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "Success"
    }
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지

CDN 상태 코드

다음은 CDN 서비스 상태를 나타내는 상태 코드로, 서비스 조회 시 서비스 상태를 확인할 수 있습니다.

값	설명
OPENING	서비스 시작 중
OPEN	서비스 중
MODIFYING	수정 중
RESUME	시작
SUSPENDING	정지 진행 중
SUSPEND	정지
CLOSING	사용 종료 중
CLOSE	사용 종료
ERROR	서비스 생성 중 오류 발생

서비스 API

서비스 생성

요청

[URI]

메서드	URI
POST	/v2.0/appKeys/{appKey}/distributions

[요청 본문]

{
    "distributions" : [
    {
      "useOriginHttpProtocolDowngrade": false,
      "forwardHostHeader": "ORIGIN_HOSTNAME",
      "domainAlias": ["alias.test.net"],
      "description" : "sample-cdn",
      "useOriginCacheControl" : false,      
      "defaultMaxAge": 86400,
      "cacheKeyQueryParam": "INCLUDE_ALL",
      "referrerType" : "BLACKLIST",     
      "referrers" : ["cloud.nhn.com"],
      "isAllowWhenEmptyReferrer" : true, 
      "origins" : [
        {
          "origin" : "static.origin.com",
          "originPath" : "/resources",       
          "httpPort": 80,
          "httpsPort": 443
        }
      ],
      "rootPathAccessControl" : {
          "enable": true,
          "controlType": "REDIRECT",
          "redirectPath": "/default.png",
          "redirectStatusCode": 302
      },
      "callback": {
          "httpMethod": "GET",
          "url": "http://test.callback.com/cdn?=appKey={appKey}&status={status}&domain={domain}"
      }
    }
  ]
}

[필드]

이름	타입	필수 여부	기본값	유효 범위	설명
distributions	List	필수			생성할 CDN의 오브젝트 목록
distributions[0].useOriginHttpProtocolDowngrade	Boolean	필수	false	true/false	원본 서버가 HTTP 응답만 가능한 경우, CDN 서버에서 원본 서버로 요청 시 HTTPS 요청을 HTTP 요청으로 다운그레이드하기 위한 설정 사용 여부
distributions[0].forwardHostHeader	String	필수		ORIGIN_HOSTNAME REQUEST_HOST_HEADER	CDN 서버가 원본 서버로 콘텐츠 요청 시 전달할 호스트 헤더 설정("ORIGIN_HOSTNAME": 원본 서버의 호스트 이름으로 설정, "REQUEST_HOST_HEADER": 클라이언트 요청의 호스트 헤더로 설정)
distributions[0].useOriginCacheControl	Boolean	필수		true/false	캐시 만료 설정(true: 원본 서버 설정 사용, false: 사용자 설정)
distributions[0].referrerType	String	필수		BLACKLIST/WHITELIST	리퍼러 접근 관리("BLACKLIST": 블랙리스트, "WHITELIST": 화이트리스트)
distributions[0].referrers	List	선택			정규 표현식 형태의 리퍼러 헤더 목록
distributions[0].isAllowWhenEmptyReferrer	Boolean	선택	true	true/false	리퍼러 헤더가 없는 경우 콘텐츠 접근 허용(true)/거부(false) 여부
distributions[0].description	String	선택		최대 255자	설명
distributions[0].domainAlias	List	선택			도메인 별칭 목록(개인 혹은 회사가 소유한 도메인 사용)
distributions[0].defaultMaxAge	Integer	선택	0	0~2,147,483,647	캐시 만료 시간(초), 기본값 0은 604,800초입니다.
distributions[0].cacheKeyQueryParam	String	선택	INCLUDE_ALL	INCLUDE_ALL/EXCLUDE_ALL	캐시 키에 요청 쿼리 문자열 포함 여부 설정("INCLUDE_ALL": 전체 포함, "EXCLUDE_ALL": 전체 미포함)
distributions[0].origins	List	필수			원본 서버 오브젝트 목록
distributions[0].origins[0].origin	String	필수		최대 255자	원본 서버(도메인 또는 IP)
distributions[0].origins[0].originPath	String	선택		최대 8192자	원본 서버 하위 경로(/를 포함한 경로로 입력해 주세요.)
distributions[0].origins[0].httpPort	Integer	선택		콘솔 사용 가이드 > 원본 서버의 '[표 2] 사용 가능한 원본 서버 포트 번호' 참고	원본 서버 HTTP 프로토콜 포트(origins[0].httpPort와 origins[0].httpsPort 중 하나는 반드시 입력해야 합니다.)
distributions[0].origins[0].httpsPort	Integer	선택		콘솔 사용 가이드 > 원본 서버의 '[표 2] 사용 가능한 원본 서버 포트 번호' 참고	원본 서버 HTTPS 프로토콜 포트(origins[0].httpPort와 origins[0].httpsPort 중 하나는 반드시 입력해야 합니다.)
distributions[0].rootPathAccessControl	Object	선택			CDN 서비스의 루트 경로에 대한 접근 제어 설정
distributions[0].rootPathAccessControl.enable	Boolean	필수	true	true/false	루트 경로에 대한 접근 제어 사용(true)/미사용(false) 여부
distributions[0].rootPathAccessControl.controlType	String	선택		DENY, REDIRECT	enable이 true일 경우 필수 입력. 루트 경로에 대한 접근 제어 방식("DENY": 접근 거부, "REDIRECT": 지정한 경로로 리다이렉트)
distributions[0].rootPathAccessControl.redirectPath	String	선택			controlType이 "REDIRECT"일 경우 필수 입력. 루트 경로에 대한 요청을 리다이렉트할 경로(/를 포함한 경로로 입력해 주세요.)
distributions[0].rootPathAccessControl.redirectStatusCode	Integer	선택		301, 302, 303, 307	controlType이 "REDIRECT"일 경우 필수 입력. 리다이렉트시 전달되는 HTTP 응답 코드
distributions[0].callback	Object	선택			CDN 생성 처리 결과를 통보받을 콜백 URL(콜백 설정은 선택 입력입니다.)
distributions[0].callback.httpMethod	String	필수		GET/POST/PUT	콜백의 HTTP 메서드
distributions[0].callback.url	String	필수		최대 1024자	콜백 URL

forwardHostHeader의 기본값은 domainAlias를 설정한 경우 REQUEST_HOST_HEADER이고, 미설정하면 ORIGIN_HOSTNAME입니다.

응답

[응답 본문]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "distributions": [
        {
            "domain": "djwbjvqa.toastcdn.net",
            "domainAlias": [
                "alias.test1.net"
            ],
            "region": "GLOBAL",
            "description": "sample-cdn",
            "status": "OPENING",
            "defaultMaxAge": 0,
            "cacheKeyQueryParam": "INCLUDE_ALL",
            "referrerType": "BLACKLIST",
            "referrers": [
                "cloud.nhn.com"
            ],
            "isAllowWhenEmptyReferrer" : true,
            "useOriginCacheControl": true,
            "origins": [
                {
                    "origin": "static.origin.com",
                    "originPath": "/resources",
                    "httpPort": 80,
                    "httpsPort": 443
                }
            ],
            "forwardHostHeader": "ORIGIN_HOSTNAME",
            "useOriginHttpProtocolDowngrade": false,
            "rootPathAccessControl" : {
                "enable": true,
                "controlType": "REDIRECT",
                "redirectPath": "/default.png",
                "redirectStatusCode": 302
            },
            "callback": {
                "httpMethod": "GET",
                "url": "http://test.callback.com/cdn?=appKey={appKey}&status={status}&domain={domain}"
            }
        }
    ]
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지
distributions	List	생성된 CDN 오브젝트 목록
distributions[0].domain	String	생성된 도메인(서비스) 이름
distributions[0].domainAlias	List	도메인 별칭 목록(개인 혹은 회사가 소유한 도메인 사용)
distributions[0].region	String	서비스 지역("GLOBAL": 글로벌)
distributions[0].description	String	설명
distributions[0].status	String	CDN 상태 코드([표] CDN 상태 코드 참고)
distributions[0].defaultMaxAge	Integer	캐시 만료 시간(초)
distributions[0].cacheKeyQueryParam	String	캐시 키에 요청 쿼리 문자열 포함 여부 설정("INCLUDE_ALL": 전체 포함, "EXCLUDE_ALL": 전체 미포함)
distributions[0].referrerType	String	리퍼러 접근 관리("BLACKLIST": 블랙리스트, "WHITELIST": 화이트리스트)
distributions[0].referrers	List	정규 표현식 형태의 리퍼러 헤더 목록
distributions[0].isAllowWhenEmptyReferrer	Boolean	리퍼러 헤더가 없는 경우 콘텐츠 접근 허용(true)/거부(false) 여부
distributions[0].useOriginCacheControl	Boolean	원본 서버 설정 사용 여부(true: 원본 서버 설정 사용, false: 사용자 설정)
distributions[0].origins	List	원본 서버 오브젝트 목록
distributions[0].origins[0].origin	String	원본 서버(도메인 또는 IP)
distributions[0].origins[0].originPath	String	원본 서버 하위 경로
distributions[0].origins[0].httpPort	Integer	원본 서버 HTTP 프로토콜 포트
distributions[0].origins[0].httpsPort	Integer	원본 서버 HTTPS 프로토콜 포트
distributions[0].useOriginHttpProtocolDowngrade	Boolean	원본 서버가 HTTP 응답만 가능한 경우, CDN 서버에서 원본 서버로 요청 시 HTTPS 요청을 HTTP 요청으로 다운그레이드하기 위한 설정 사용 여부
distributions[0].forwardHostHeader	String	CDN 서버가 원본 서버로 콘텐츠 요청 시 전달 할 호스트 헤더 설정("ORIGIN_HOSTNAME": 원본 서버의 호스트 이름으로 설정, "REQUEST_HOST_HEADER": 클라이언트 요청의 호스트헤더로 설정
distributions[0].rootPathAccessControl	Object	CDN 서비스의 루트 경로에 대한 접근 제어 설정
distributions[0].rootPathAccessControl.enable	Boolean	루트 경로에 대한 접근 제어 사용(true)/미사용(false) 여부
distributions[0].rootPathAccessControl.controlType	String	enable이 true일 경우 필수 입력. 루트 경로에 대한 접근 제어 방식("DENY": 접근 거부, "REDIRECT": 지정한 경로로 리다이렉트)
distributions[0].rootPathAccessControl.redirectPath	String	controlType이 "REDIRECT"일 경우 필수 입력. 루트 경로에 대한 요청을 리다이렉트할 경로(/를 포함한 경로로 입력해 주세요.)
distributions[0].rootPathAccessControl.redirectStatusCode	Integer	controlType이 "REDIRECT"일 경우 필수 입력. 리다이렉트시 전달되는 HTTP 응답 코드
distributions[0].callback	Object	서비스 생성 처리 결과를 통보받을 콜백
distributions[0].callback.httpMethod	String	콜백의 HTTP 메서드
distributions[0].callback.url	String	콜백 URL

서비스 조회

요청

[URI]

메서드	URI
GET	/v2.0/appKeys/{appKey}/distributions

[파라미터]

이름	타입	필수 여부	유효 범위	설명
domain	String	선택	최대 255자	조회할 도메인(서비스 이름)
status	String	선택	CDN 상태 코드	CDN 상태 코드([표] CDN 상태 코드 참고)

[예]

curl -X GET "https://kr1-cdn.api.nhncloudservice.com/v2.0/appKeys/{appKey}/distributions?domain={domain}" \
 -H "Authorization: {secretKey}" \
 -H "Content-Type: application/json"

응답

[응답 본문]

{
    "header" : {
        "resultCode" :  0,
        "resultMessage" :  "SUCCESS",
      "isSuccessful" :  true
    },
    "domain" :  "lhcsxuo0.toastcdn.net",
    "domainAlias" :  ["test.domain.com"],
    "region" :  "GLOBAL",
    "status" : "OPEN",
    "defaultMaxAge" : 86400,
    "cacheKeyQueryParam": "INCLUDE_ALL",
    "status" :  "OPENING",
    "referrerType" :  "BLACKLIST",
    "referrers" :  ["test.com"],    
    "useOriginCacheControl" :  false,
    "origins" : [
        {
            "origin" :  "static.resource.com",
            "httpPort" :  80,
            "httpsPort" : 443
        }
    ],
    "forwardHostHeader": "ORIGIN_HOSTNAME",
    "useOriginHttpProtocolDowngrade": false,   
    "rootPathAccessControl" : {
        "enable": true,
        "controlType": "REDIRECT",
        "redirectPath": "/default.png",
        "redirectStatusCode": 302
    }, 
    "callback": {
        "httpMethod": "GET",
        "url": "http://test.callback.com/cdn?=appKey={appKey}&status={status}&domain={domain}"
    }
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지
distributions	List	생성된 CDN 오브젝트 목록
distributions[0].domain	String	도메인 이름(서비스 이름)
distributions[0].domainAlias	List	도메인 별칭 목록(개인 혹은 회사가 소유한 도메인 사용)
distributions[0].region	String	서비스 지역("GLOBAL": 글로벌)
distributions[0].status	String	CDN 상태 코드([표] CDN 상태 코드 참고)
distributions[0].defaultMaxAge	Integer	캐시 만료 시간(초)
distributions[0].cacheKeyQueryParam	String	캐시 키에 요청 쿼리 문자열 포함 여부 설정("INCLUDE_ALL": 전체 포함, "EXCLUDE_ALL": 전체 미포함)
distributions[0].referrerType	String	리퍼러 접근 관리("BLACKLIST": 블랙리스트, "WHITELIST": 화이트리스트)
distributions[0].referrers	List	정규 표현식 형태의 리퍼러 헤더 목록
distributions[0].isAllowWhenEmptyReferrer	Boolean	리퍼러 헤더가 없는 경우 콘텐츠 접근 허용(true)/거부(false) 여부
distributions[0].useOriginCacheControl	Boolean	원본 서버 설정 사용 여부(true: 원본 서버 설정 사용, false: 사용자 설정)
distributions[0].origins	List	원본 서버 오브젝트 목록
distributions[0].origins[0].origin	String	원본 서버(도메인 또는 IP)
distributions[0].origins[0].originPath	String	원본 서버 하위 경로
distributions[0].origins[0].httpPort	Integer	원본 서버 HTTP 프로토콜 포트
distributions[0].origins[0].httpsPort	Integer	원본 서버 HTTPS 프로토콜 포트
distributions[0].forwardHostHeader	String	서비스 배포 처리 결과를 통보받을 콜백
distributions[0].useOriginHttpProtocolDowngrade	Boolean	원본 서버가 HTTP 응답만 가능한 경우, CDN 서버에서 원본 서버로 요청 시 HTTPS 요청을 HTTP 요청으로 다운그레이드하기 위한 설정 사용 여부
distributions[0].forwardHostHeader	String	CDN 서버가 원본 서버로 콘텐츠 요청 시 전달 할 호스트 헤더 설정("ORIGIN_HOSTNAME": 원본 서버의 호스트 이름으로 설정, "REQUEST_HOST_HEADER": 클라이언트 요청의 호스트헤더로 설정
distributions[0].rootPathAccessControl	Object	CDN 서비스의 루트 경로에 대한 접근 제어 설정
distributions[0].rootPathAccessControl.enable	Boolean	루트 경로에 대한 접근 제어 사용(true)/미사용(false) 여부
distributions[0].rootPathAccessControl.controlType	String	enable이 true일 경우 필수 입력. 루트 경로에 대한 접근 제어 방식("DENY": 접근 거부, "REDIRECT": 지정한 경로로 리다이렉트)
distributions[0].rootPathAccessControl.redirectPath	String	controlType이 "REDIRECT"일 경우 필수 입력. 루트 경로에 대한 요청을 리다이렉트할 경로(/를 포함한 경로로 입력해 주세요.)
distributions[0].rootPathAccessControl.redirectStatusCode	Integer	controlType이 "REDIRECT"일 경우 필수 입력. 리다이렉트시 전달되는 HTTP 응답 코드
distributions[0].callback	Object	서비스 배포 처리 결과를 통보받을 콜백
distributions[0].callback.httpMethod	String	콜백의 HTTP 메서드
distributions[0].callback.url	String	콜백 URL

서비스 수정

요청

[URI]

메서드	URI
PUT	/v2.0/appKeys/{appKey}/distributions

[요청 본문]

{
    "distributions" : [
    {
      "domain" : "sample.toastcdn.net",
      "useOriginCacheControl" : false,
      "defaultMaxAge": 86400,
      "cacheKeyQueryParam": "INCLUDE_ALL",
      "referrerType" : "BLACKLIST",
      "referrers" : ["test.com"],
      "origins" : [
          {
              "origin" : "static.resource.com",
              "httpPort" : 80,
              "httpsPort" : 443,
              "originPath" : "/latest/resources"
          }
      ],
      "useOriginHttpProtocolDowngrade": false,
      "forwardHostHeader": "ORIGIN_HOSTNAME",
      "rootPathAccessControl" : {
          "enable": true,
          "controlType": "REDIRECT",
          "redirectPath": "/default.png",
          "redirectStatusCode": 302
      },
      "callback": {
          "httpMethod": "GET",
          "url": "http://test.callback.com/cdn?=appKey={appKey}&status={status}&domain={domain}"
      },
      "description" : "change contents"        
    }
  ]
}

[필드]

이름	타입	필수 여부	기본값	유효 범위	설명
domain	String	필수		최대 255자	수정할 도메인(서비스 이름)
useOriginCacheControl	Boolean	필수		true/false	캐시 만료 설정(true: 원본 서버 설정 사용, false: 사용자 설정)
referrerType	String	필수		BLACKLIST/WHITELIST	리퍼러 접근 관리("BLACKLIST": 블랙리스트, "WHITELIST": 화이트리스트)
referrers	List	선택			정규 표현식 형태의 리퍼러 헤더 목록
isAllowWhenEmptyReferrer	Boolean	선택	true	true/false	리퍼러 헤더가 없는 경우 콘텐츠 접근 허용(true)/거부(false) 여부
description	String	선택		최대 255자	설명
domainAlias	List	선택		최대 255자	도메인 별칭(개인 혹은 회사가 소유한 도메인 사용)
defaultMaxAge	Integer	선택	0	0~2,147,483,647	캐시 만료 시간(초), 기본값 0은 604,800초입니다.
cacheKeyQueryParam	String	선택	INCLUDE_ALL	INCLUDE_ALL/EXCLUDE_ALL	캐시 키에 요청 쿼리 문자열 포함 여부 설정("INCLUDE_ALL": 전체 포함, "EXCLUDE_ALL": 전체 미포함)
origins	List	필수			원본 서버
origins[0].origin	String	필수		최대 255자	원본 서버(도메인 또는 IP)
origins[0].originPath	String	선택		최대 8192자	원본 서버 하위 경로
origins[0].httpPort	Integer	선택		콘솔 사용 가이드 > 원본 서버의 '[표 2] 사용 가능한 원본 서버 포트 번호' 참고	원본 서버 HTTP 프로토콜 포트(origins[0].httpPort와 origins[0].httpsPort 중 하나는 반드시 입력해야 합니다.)
origins[0].httpsPort	Integer	선택		콘솔 사용 가이드 > 원본 서버의 '[표 2] 사용 가능한 원본 서버 포트 번호' 참고	원본 서버 HTTPS 프로토콜 포트(origins[0].httpPort와 origins[0].httpsPort 중 하나는 반드시 입력해야 합니다.)
useOriginHttpProtocolDowngrade	Boolean	필수	false	true/false	원본 서버가 HTTP 응답만 가능한 경우, CDN 서버에서 원본 서버로 요청 시 HTTPS 요청을 HTTP 요청으로 다운그레이드하기 위한 설정 사용 여부
forwardHostHeader	String	필수		ORIGIN_HOSTNAME REQUEST_HOST_HEADER	CDN 서버가 원본 서버로 콘텐츠 요청 시 전달할 호스트 헤더 설정("ORIGIN_HOSTNAME": 원본 서버의 호스트 이름으로 설정, "REQUEST_HOST_HEADER": 클라이언트 요청의 호스트 헤더로 설정)
useOrigin	String	필수		Y/N	캐시 만료 설정(Y: 원본 설정 사용, "N":사용자 설정 사용)
rootPathAccessControl	Object	선택			CDN 서비스의 루트 경로에 대한 접근 제어 설정
rootPathAccessControl.enable	Boolean	필수	false	true/false	루트 경로에 대한 접근 제어 사용(true)/미사용(false) 여부
rootPathAccessControl.controlType	String	선택		DENY, REDIRECT	enable이 true일 경우 필수 입력. 루트 경로에 대한 접근 제어 방식("DENY": 접근 거부, "REDIRECT": 지정한 경로로 리다이렉트)
rootPathAccessControl.redirectPath	String	선택			controlType이 "REDIRECT"일 경우 필수 입력. 루트 경로에 대한 요청을 리다이렉트할 경로(/를 포함한 경로로 입력해 주세요.)
rootPathAccessControl.redirectStatusCode	Integer	선택		301, 302, 303, 307	controlType이 "REDIRECT"일 경우 필수 입력. 리다이렉트시 전달되는 HTTP 응답 코드
callback	Object	선택		CDN 서비스 배포 결과를 통보받을 콜백 URL(콜백 설정은 선택 입력입니다.)
callback.httpMethod	String	필수		GET/POST/PUT	콜백의 HTTP 메서드
callback.url	String	필수		최대 1024자	콜백 URL

forwardHostHeader의 기본값은 domainAlias를 설정한 경우 REQUEST_HOST_HEADER이고, 미설정하면 ORIGIN_HOSTNAME입니다.

응답

[응답 본문]

{
    "header" : {
        "resultCode" :  0,
        "resultMessage" :  "SUCCESS",
        "isSuccessful" :  true
    }
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지

서비스 삭제

요청

[URI]

메서드	URI
DELETE	/v2.0/appKeys/{appKey}/distributions

[요청 본문]

{
    "domains" : [
        "lhcsxuo0.toastcdn.net"
    ]
}

[필드]

이름	타입	필수 여부	기본값	유효 범위	설명
domains	String	필수			삭제할 도메인, 여러 도메인 입력 가능

* 여러 도메인 입력 시, 해당하는 서비스는 모두 종료됩니다.

응답

[응답 본문]

{
    "header" : {
        "resultCode" :  0,
        "resultMessage" :  "SUCCESS",
        "isSuccessful" :  true
    }
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지

캐시 재배포 API

캐시 재배포(Purge) - ITEM(특정 파일 타입)

요청

[URI]

메서드	URI
POST	/v2.0/appKeys/{appKey}/purge/item

[요청 본문]

{
    "domain": "sample.toastcdn.net",
    "purgeList":["http://sample.toastcdn.net/img_01.png",
  "http://sample.toastcdn.net/img_02.png"]
}

[필드]

이름	타입	필수 여부	기본값	유효 범위	설명
domain	String	필수		최대 255자	재배포할 도메인(서비스) 이름
purgeList	List	필수			재배포 대상 URL 목록

응답

[응답 본문]

{
    "header" : {
        "resultCode" :  0,
        "resultMessage" :  "SUCCESS",
        "isSuccessful" :  true
    }
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지

캐시 재배포(Purge) - ALL(전체 파일 타입)

요청

[URI]

메서드	URI
POST	/v2.0/appKeys/{appKey}/purge/all

[요청 본문]

{
    "domain": "sample.toastcdn.net"
}

[필드]

이름	타입	필수 여부	기본값	유효 범위	설명
domain	String	필수		최대 255자	재배포할 도메인(서비스) 이름

응답

[응답 본문]

{
    "header" : {
        "resultCode" :  0,
        "resultMessage" :  "SUCCESS",
        "isSuccessful" :  true
    }
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지

CDN 서비스를 신규로 생성한 후 약 1시간 이내에는 캐시 재배포 요청이 실패할 수 있습니다. 이후에도 실패가 계속되면 고객 센터로 문의해 주시기 바랍니다.
퍼지 API 사용량 제한 정책이 있습니다. 자세한 내용은 콘솔 사용 가이드 > CDN 캐시 재배포의 캐시 재배포 사용량 제한] 내용을 확인해주세요.

캐시 재배포(Purge) 조회

API v2.0을 통한 캐시 재배포 시, 고속 캐시 재배포가 수행되어 요청 후 수 초 이내에 완료되므로 캐시 재배포 상태를 조회하는 API가 별도로 제공되지 않습니다.

콜백 응답

CDN 서비스에 콜백 기능이 설정된 경우, 생성, 수정, 일시 정지, 재개, 삭제 변경이 완료되면 설정된 콜백 URL을 호출합니다. 콜백 호출시 요청 본문에는 다음과 같은 CDN 서비스 설정 정보가 포함됩니다.

[응답 본문]

{
  "header" : {
    "resultCode" :  0,
    "resultMessage" :  "SUCCESS",
    "isSuccessful" :  true
  },
  "distribution":{
      "appKey": "wXDdIjJRcZDtY9F7",
      "domain" :  "lhcsxuo0.toastcdn.net",
      "domainAlias" :  ["test.domain.com"],
      "region" :  "GLOBAL",
      "status" : "OPEN",
      "defaultMaxAge" : 86400,
      "cacheKeyQueryParam": "INCLUDE_ALL",
      "status" :  "OPENING",
      "referrerType" :  "BLACKLIST",
      "referrers" :  ["test.com"],    
      "useOriginCacheControl" :  false,
      "createTime" : 1498613094692,
      "deleteTime": 1498613094692,
      "origins" : [
          {
              "origin" :  "static.resource.com",
              "httpPort" :  80,
              "httpsPort" : 443
          }
      ],
      "forwardHostHeader": "ORIGIN_HOSTNAME",
      "useOriginHttpProtocolDowngrade": false,    
      "rootPathAccessControl" : {
          "enable": true,
          "controlType": "REDIRECT",
          "redirectPath": "/default.png",
          "redirectStatusCode": 302
      },
      "callback": {
          "httpMethod": "GET",
          "url": "http"
      }
  }
}

[필드]

필드	타입	설명
header	Object	헤더 영역
header.isSuccessful	Boolean	성공 여부
header.resultCode	Integer	결과 코드
header.resultMessage	String	결과 메시지
distribution	Object	변경 작업이 완료된 CDN 오브젝트
distribution.appKey	String	앱키
distribution.domain	String	도메인 이름(서비스 이름)
distribution.domainAlias	List	도메인 별칭 목록(개인 혹은 회사가 소유한 도메인 사용)
distribution.region	String	서비스 지역("GLOBAL": 글로벌)
distribution.status	String	CDN 상태 코드([표] CDN 상태 코드 참고)
distribution.defaultMaxAge	Integer	캐시 만료 시간(초)
distribution.cacheKeyQueryParam	String	캐시 키에 요청 쿼리 문자열 포함 여부 설정("INCLUDE_ALL": 전체 포함, "EXCLUDE_ALL": 전체 미포함)
distribution.referrerType	String	리퍼러 접근 관리("BLACKLIST": 블랙리스트, "WHITELIST": 화이트리스트)
distribution.referrers	List	정규 표현식 형태의 리퍼러 헤더 목록
distribution.useOriginCacheControl	Boolean	원본 서버 설정 사용 여부(true: 원본 서버 설정 사용, false: 사용자 설정)
distribution.createTime	DateTime	생성 일시
distribution.deleteTime	DateTime	삭제 일시
distribution.origins	List	원본 서버 오브젝트 목록
distribution.origins[0].origin	String	원본 서버(도메인 또는 IP)
distribution.origins[0].originPath	String	원본 서버 하위 경로
distribution.origins[0].httpPort	Integer	원본 서버 HTTP 프로토콜 포트
distribution.origins[0].httpsPort	Integer	원본 서버 HTTPS 프로토콜 포트
distribution.useOriginHttpProtocolDowngrade	Boolean	원본 서버가 HTTP 응답만 가능한 경우, CDN 서버에서 원본 서버로 요청 시 HTTPS 요청을 HTTP 요청으로 다운그레이드하기 위한 설정 사용 여부
distribution.forwardHostHeader	String	CDN 서버가 원본 서버로 콘텐츠 요청 시 전달 할 호스트 헤더 설정("ORIGIN_HOSTNAME": 원본 서버의 호스트 이름으로 설정, "REQUEST_HOST_HEADER": 클라이언트 요청의 호스트헤더로 설정
distribution.rootPathAccessControl	Object	CDN 서비스의 루트 경로에 대한 접근 제어 설정
distribution.rootPathAccessControl.enable	Boolean	루트 경로에 대한 접근 제어 사용(true)/미사용(false) 여부
distribution.rootPathAccessControl.controlType	String	enable이 true일 경우 필수 입력. 루트 경로에 대한 접근 제어 방식("DENY": 접근 거부, "REDIRECT": 지정한 경로로 리다이렉트)
distribution.rootPathAccessControl.redirectPath	String	controlType이 "REDIRECT"일 경우 필수 입력. 루트 경로에 대한 요청을 리다이렉트할 경로(/를 포함한 경로로 입력해 주세요.)
distribution.rootPathAccessControl.redirectStatusCode	Integer	controlType이 "REDIRECT"일 경우 필수 입력. 리다이렉트시 전달되는 HTTP 응답 코드
distribution.callback	Object	서비스 배포 처리 결과를 통보받을 콜백
distribution.callback.httpMethod	String	콜백의 HTTP 메서드
distribution.callback.url	String	콜백 URL

Content Delivery > CDN > API v2.0 가이드
API 공통 정보
도메인
사전 준비
요청 공통 정보
응답 공통 정보
서비스 API
서비스 생성
서비스 조회
서비스 수정
서비스 삭제
캐시 재배포 API
캐시 재배포(Purge) - ITEM(특정 파일 타입)
캐시 재배포(Purge) - ALL(전체 파일 타입)
캐시 재배포(Purge) 조회
콜백 응답

TOP

Content Delivery > CDN > API v2.0 가이드

API 공통 정보

도메인

사전 준비

요청 공통 정보

요청 헤더

Path 파라미터

응답 공통 정보

헤더

CDN 상태 코드

서비스 API

서비스 생성

요청

응답

서비스 조회

요청

응답

서비스 수정

요청

응답

서비스 삭제

요청

응답

캐시 재배포 API

캐시 재배포(Purge) - ITEM(특정 파일 타입)

요청

응답

캐시 재배포(Purge) - ALL(전체 파일 타입)

요청

응답

캐시 재배포(Purge) 조회

콜백 응답

목차