getCdnPlusInstanceList
  • PDF

getCdnPlusInstanceList

  • PDF

Overview

Gets a list of CDN+ instances.

Request

Request parameters

Parameter Required Type Limitations Description
cdnInstanceNo N String CDN instance number
pageNo N Integer Min: 0,
Max: 2147483647
Page number based on the page size if the number of items is large.
pageSize N Integer Min: 0,
Max: 2147483647
Number of items to be shown per page
responseFormatType N String JSON or XML Response type

Response

The API returns an HTTP status code indicating success or failure.

HTTP status code Code message Description
200 Success Succeeded
401 Unauthorized Authentication failed
500 Internal Server Error Server error

Properties

Property Required Type Description
cdnInstanceNo N String CDN instance number
cdnInstanceStatus N CommonCode CDN instance status
cdnInstanceStatus N CommonCode CDN instance status
cdnInstanceStatusName N String CDN instance status name
createDate N String Creation date
lastModifiedDate N String UPTIME
cdnInstanceDescription N String CDN instance description
serviceName N String Service name
isForLiveTranscoder N Boolean Indicates whether it is a live transcoder.
liveTranscoderInstanceNoList N List<String> List of live transcoder instance numbers
isForImageOptimizer N Boolean Indicates whether it is an ImageOptimizer.
imageOptimizerInstanceNo N String List of ImageOptimizer instance numbers
isAvailablePartialDomainPurge N Boolean
cdnPlusServiceDomainList N List<CdnPlusServiceDomain> List of CDN+ service domains
domainId N String Domain ID
serviceDomainTypeCode N String Service domain type code
protocolTypeCode N String Protocol type code
defaultDomainName N String Default domain name
userDomainName N String User domain name
cdnPlusRule N CdnPlusRule CDN settings

Examples

Request example

https://ncloud.apigw.ntruss.com/cdn/v2/getCdnPlusInstanceList?cdnInstanceNo=711484&responseFormatType=XML

Response example

<?xml version="1.0" encoding="UTF-8"?>
<getCdnPlusInstanceListResponse>
  <requestId>8a19fde8-8a3b-4f61-b291-4a3f586e3c9c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cdnPlusInstanceList>
    <cdnPlusInstance>
      <cdnInstanceNo>711484</cdnInstanceNo>
      <cdnInstanceStatus>
        <code>RUN</code>
        <codeName>CDN Plus Run State</codeName>
      </cdnInstanceStatus>
      <cdnInstanceOperation>
        <code>NULL</code>
        <codeName>CDN3 NULL OP</codeName>
      </cdnInstanceOperation>
      <cdnInstanceStatusName>running</cdnInstanceStatusName>
      <createDate>2018-03-29T21:32:18+0900</createDate>
      <lastModifiedDate>2018-12-06T21:55:25+0900</lastModifiedDate>
      <cdnInstanceDescription></cdnInstanceDescription>
      <serviceName>cdn-log-test3</serviceName>
      <isForLiveTranscoder>false</isForLiveTranscoder>
      <liveTranscoderInstanceNoList/>
      <isForImageOptimizer>false</isForImageOptimizer>
      <imageOptimizerInstanceNo></imageOptimizerInstanceNo>
      <isAvailablePartialDomainPurge>false</isAvailablePartialDomainPurge>
      <cdnPlusServiceDomainList>
        <cdnPlusServiceDomain>
          <domainId>CD000000000000008054</domainId>
          <serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
          <protocolTypeCode>HTTP</protocolTypeCode>
          <defaultDomainName>sjktsyeuckvp711484.cdn.ntruss.com</defaultDomainName>
          <userDomainName></userDomainName>
        </cdnPlusServiceDomain>
      </cdnPlusServiceDomainList>
      <cdnPlusRule>
        <protocolTypeCode>HTTP</protocolTypeCode>
        <serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
        <originUrl>ncp-cdn.origin.navercdn.com</originUrl>
        <originPath></originPath>
        <originHttpPort>80</originHttpPort>
        <originHttpsPort>0</originHttpsPort>
        <forwardHostHeaderTypeCode>REQUEST_HOST_HEADER</forwardHostHeaderTypeCode>
        <forwardHostHeader></forwardHostHeader>
        <cacheKeyHostNameTypeCode>REQUEST_HOST_HEADER</cacheKeyHostNameTypeCode>
        <isGzipCompressionUse>true</isGzipCompressionUse>
        <cachingOptionTypeCode>CACHE_CONTROL_MAX_AGE</cachingOptionTypeCode>
        <isErrorContentsResponseUse>false</isErrorContentsResponseUse>
        <cachingTtlTime>604800</cachingTtlTime>
        <isQueryStringIgnoreUse>true</isQueryStringIgnoreUse>
        <isRemoveVaryHeaderUse>true</isRemoveVaryHeaderUse>
        <isLargeFileOptimizationUse>false</isLargeFileOptimizationUse>
        <gzipResponseTypeCode>ORIGIN_RESPONSE</gzipResponseTypeCode>
        <isReferrerDomainUse>true</isReferrerDomainUse>
        <referrerDomainList>
          <string>www.naver.com</string>
          <string>*.naver.com</string>
        </referrerDomainList>
        <isReferrerDomainRestrictUse>false</isReferrerDomainRestrictUse>
        <isSecureTokenUse>false</isSecureTokenUse>
        <secureTokenPassword></secureTokenPassword>
        <isReissueSecureTokenPassword>false</isReissueSecureTokenPassword>
        <certificateName></certificateName>
        <isAccessLogUse>true</isAccessLogUse>
        <accessLogFileStorageContainerName>cdnlogtest</accessLogFileStorageContainerName>
        <isRequestCustomHeaderUse>false</isRequestCustomHeaderUse>
        <requestCustomHeaderList/>
        <isResponseCustomHeaderUse>false</isResponseCustomHeaderUse>
        <responseCustomHeaderList/>
      </cdnPlusRule>
    </cdnPlusInstance>
  </cdnPlusInstanceList>
</getCdnPlusInstanceListResponse>

Error codes

Error code Description
29200 Invalid CDN rule.
29201 Cannot operate this CDN service. Please check status.
29202 Invalid CDN purge request.
29203 Invalid CDN service domain type code.
29204 Invalid CDN instance.
29205 Unable to control the CDN service because this CDN service is for Live Transcoder.
29211 An error occurred while creating CDN service.
29215 This CDN service cannot request purge with partial domains.
29216 Invalid CDN service domain.
29209 The certificate cannot register for CDN.
29217 Please enter target file list or directory.
29218 Please select target service domains.
29221 Unable to control the CDN service because this CDN service is for Image Optimizer.
29222 Invalid image optimizer instance number.
29223 Cache Key Hostname cannot be set Origin Hostname if there is only one service domain.
29224 Cache Key Hostname cannot be set Origin Hostname if use CDN domain.

Was this article helpful?