인스턴스 조회

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

Global CDN 인스턴스 목록을 조회합니다.

요청

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

메서드	URI
GET \| POST	/cdn/v2/getGlobalCdnInstanceList

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`cdnInstanceNo`	String	Optional	CDN 인스턴스 번호
`pageNo`	Integer	Optional	페이지 번호 0~2147483647
`pageSize`	Integer	Optional	페이지당 항목 수 0~2147483647
`responseFormatType`	String	Optional	응답 데이터의 형식 `xml` (기본값) \| `json`

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/cdn/v2/getGlobalCdnInstanceList?responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`getGlobalCdnInstanceListResponse`	Object	-	응답 결과
`getGlobalCdnInstanceListResponse.totalRows`	Integer	-	응답 결과 수
`getGlobalCdnInstanceListResponse.globalCdnInstanceList`	Array	-	인스턴스 목록
`getGlobalCdnInstanceListResponse.requestId`	String	-	요청에 대한 아이디 UUID 형식
`getGlobalCdnInstanceListResponse.returnCode`	String	-	응답 코드
`getGlobalCdnInstanceListResponse.returnMessage`	String	-	응답 메시지

`globalCdnInstanceList`

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

필드	타입	필수 여부	설명
`cdnInstanceNo`	String	-	CDN 인스턴스 아이디
`cdnInstanceStatusName`	String	-	CDN 인스턴스 상태
`cdnInstanceDescription`	String	-	CDN 인스턴스 설명
`serviceName`	String	-	서비스 이름
`isAvailablePartialDomainPurge`	Boolean	-	부분 퍼지 수행 가능 여부 `true` \| `false` `true`: 가능 `false`: 불가능
`globalCdnServiceDomainList`	Array	-	서비스 도메인 목록: globalCdnServiceDomainList
`globalCdnRule`	Object	-	CDN 설정
`globalCdnRule.protocolTypeCode`	String	-	서비스 프로토콜 유형
`globalCdnRule.serviceDomainTypeCode`	String	-	서비스 도메인 유형 `DEFAULT` \| `USER` `DEFAULT`: 네이버 클라우드 플랫폼에서 제공되는 CDN 도메인 `USER`: 사용자 보유 도메인
`globalCdnRule.originUrl`	String	-	원본 위치
`globalCdnRule.originPath`	String	-	원본 상세 경로
`globalCdnRule.originHttpPort`	Integer	-	원본 HTTP 포트
`globalCdnRule.originHttpsPort`	Integer	-	원본 HTTPS 포트
`globalCdnRule.forwardHostHeaderTypeCode`	String	-	호스트 헤더 포워딩 유형 `REQUEST_HOST_HEADER` \| `ORIGIN_HOSTNAME` \| `CUSTOM` `REQUEST_HOST_HEADER`: 클라이언트에서 전달받은 헤더 사용 `ORIGIN_HOSTNAME`: 특정 값으로 헤더 치환 `CUSTOM`: 헤더 값 지정
`globalCdnRule.forwardHostHeader`	String	-	호스트 헤더 값 `globalCdnRule.forwardHostHeaderTypeCode`가 `CUSTOM`인 경우, 유효 값 표시
`globalCdnRule.cacheKeyHostNameTypeCode`	String	-	캐시 키 호스트 이름 유형 `REQUEST_HOST_HEADER` \| `ORIGIN_HOSTNAME` `REQUEST_HOST_HEADER`: 캐시 키에 서비스 도메인 포함 `ORIGIN_HOSTNAME`: 캐시 키에 원본 서버의 호스트 이름 포함
`globalCdnRule.isGzipCompressionUse`	Boolean	-	Gzip 압축 전송 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함 사용 시 응답 시간 단축
`globalCdnRule.cachingOptionTypeCode`	String	-	캐시 옵션
`globalCdnRule.isErrorContentsResponseUse`	Boolean	-	원본 사용 불가 시 캐싱된 오류 콘텐츠 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`globalCdnRule.cachingTtlTime`	Integer	-	캐시 최대 보관 기간(초)
`globalCdnRule.isQueryStringIgnoreUse`	Boolean	-	쿼리 스트링 무시 여부 `true` \| `false` `true`: 무시 `false`: 무시 안 함
`globalCdnRule.isRemoveVaryHeaderUse`	Boolean	-	Vary 헤더 제거 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함 사용 시 원본 서버 응답의 Accept-Encoding 외 Vary 헤더 제거 후 캐싱
`globalCdnRule.isLargeFileOptimizationUse`	Boolean	-	대용량 파일 전송 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함 사용 시 대용량 파일 전송 성능 및 안정성 최적화
`globalCdnRule.gzipResponseTypeCode`	String	-	Gzip 압축 전송 유형 `ORIGIN_RESPONSE` \| `NEVER` \| `ALWAYS` `ORIGIN_RESPONSE`: 원본의 압축 설정과 동일하게 적용 `NEVER`: 사용 안 함 `ALWAYS`: 사용
`globalCdnRule.isReferrerDomainUse`	Boolean	-	레퍼러 도메인 접근 제어 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함 요청에 특정 레퍼러 도메인이 포함된 경우에만 응답
`globalCdnRule.referrerDomainList`	Array	-	허용 레퍼러 도메인 목록
`globalCdnRule.isReferrerDomainRestrictUse`	Boolean	-	레퍼러 부재 시 접근 차단 여부 `true` \| `false` `true`: 차단 `false`: 허용
`globalCdnRule.isSecureTokenUse`	Boolean	-	보안 토큰 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함 토큰으로 요청을 인증하여 통과된 경우에만 응답
`globalCdnRule.secureTokenPassword`	String	-	토큰 키 값
`globalCdnRule.isAccessLogUse`	Boolean	-	접근 로그 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`globalCdnRule.isRequestCustomHeaderUse`	Boolean	-	요청 시 Custom 헤더 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`globalCdnRule.requestCustomHeaderList`	Array	-	Custom 헤더 목록: globalCdnCustomHeader
`globalCdnRule.isResponseCustomHeaderUse`	Boolean	-	응답 시 Custom 헤더 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`globalCdnRule.responseCustomHeaderList`	Array	-	Custom 헤더 목록: globalCdnCustomHeader

`globalCdnServiceDomainList`

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

필드	타입	필수 여부	설명
`serviceDomainTypeCode`	String	-	서비스 도메인 구분 `DEFAULT` \| `USER` `DEFAULT`: 네이버 클라우드 플랫폼에서 제공하는 CDN 도메인 `USER`: 사용자 보유 도메인
`protocolTypeCode`	String	-	서비스 프로토콜
`defaultDomainName`	String	-	네이버 클라우드 플랫폼 도메인 이름
`userDomainName`	String	-	사용자 도메인 이름

`globalCdnCustomHeader`

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

필드	타입	필수 여부	설명
`headerTypeCode`	String	-	헤더 유형 `REQUEST` \| `RESPONSE` `REQUEST`: 요청 헤더 `RESPONSE`: 응답 헤더
`actionTypeCode`	String	-	액션 유형 `ADD` \| `MODIFY` \| `REMOVE` `ADD`: 추가 `MODIFY`: 수정 `REMOVE`: 삭제
`headerName`	String	-	헤더 이름
`headerValue`	String	-	헤더 값

응답 상태 코드

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

응답 예시

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

{
    "getGlobalCdnInstanceListResponse": {
        "totalRows": 3,
        "globalCdnInstanceList": [
            {
                "cdnInstanceNo": "2851****",
                "cdnInstanceStatusName": "running",
                "cdnInstanceDescription": "",
                "serviceName": "cdn000",
                "isAvailablePartialDomainPurge": false,
                "globalCdnServiceDomainList": [
                    {
                        "serviceDomainTypeCode": "DEFAULT",
                        "protocolTypeCode": "HTTP",
                        "defaultDomainName": "fdhv**************.gcdn.ntruss.com",
                        "userDomainName": ""
                    }
                ],
                "globalCdnRule": {
                    "protocolTypeCode": "HTTP",
                    "serviceDomainTypeCode": "DEFAULT",
                    "originUrl": "data4c8f9378.kr.object.ncloudstorage.com",
                    "originPath": "/year%3D2023",
                    "originHttpPort": 80,
                    "originHttpsPort": 0,
                    "forwardHostHeaderTypeCode": "ORIGIN_HOSTNAME",
                    "forwardHostHeader": "",
                    "cacheKeyHostNameTypeCode": "REQUEST_HOST_HEADER",
                    "isGzipCompressionUse": true,
                    "cachingOptionTypeCode": "EXPIRES",
                    "isErrorContentsResponseUse": true,
                    "cachingTtlTime": 604800,
                    "isQueryStringIgnoreUse": true,
                    "isRemoveVaryHeaderUse": true,
                    "isLargeFileOptimizationUse": true,
                    "gzipResponseTypeCode": "ORIGIN_RESPONSE",
                    "isReferrerDomainUse": false,
                    "referrerDomainList": [],
                    "isReferrerDomainRestrictUse": false,
                    "isSecureTokenUse": true,
                    "secureTokenPassword": "fd5*************",
                    "isAccessLogUse": true,
                    "isRequestCustomHeaderUse": true,
                    "requestCustomHeaderList": [
                        {
                            "headerTypeCode": "REQUEST",
                            "actionTypeCode": "DELETE",
                            "headerName": "date",
                            "headerValue": ""
                        }
                    ],
                    "isResponseCustomHeaderUse": true,
                    "responseCustomHeaderList": [
                        {
                            "headerTypeCode": "RESPONSE",
                            "actionTypeCode": "ADD",
                            "headerName": "client",
                            "headerValue": "remote"
                        }
                    ]
                }
            },
            ...
        ],
        "requestId": "7c3662e4-****-****-****-0a15aa98a9a9",
        "returnCode": "0",
        "returnMessage": "success"
    }
}