getGlobalCdnInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Gets a list of global 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
cdnInstanceOperation	N	CommonCode	CDN instance OP
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
isAvailablePartialDomainPurge	N	Boolean
globalCdnServiceDomainList	N	List<GlobalCdnServiceDomain>	List of global CDN service domains
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
globalCdnRule	N	GlobalCdnRule	Global CDN settings

Examples

Request example

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

Response example

<?xml version="1.0" encoding="UTF-8"?>
<getGlobalCdnInstanceListResponse>
  <requestId>ff7b0034-82a1-4c8f-8c9a-527a71b430e7</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <globalCdnInstanceList>
    <globalCdnInstance>
      <cdnInstanceNo>697750</cdnInstanceNo>
      <cdnInstanceStatusName>running</cdnInstanceStatusName>
      <createDate>2018-03-20T14:39:31+0900</createDate>
      <lastModifiedDate>2018-03-20T15:01:44+0900</lastModifiedDate>
      <cdnInstanceDescription></cdnInstanceDescription>
      <serviceName>gcdn-test</serviceName>
      <isAvailablePartialDomainPurge>false</isAvailablePartialDomainPurge>
      <globalCdnServiceDomainList>
        <globalCdnServiceDomain>
          <serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
          <protocolTypeCode>HTTP</protocolTypeCode>
          <defaultDomainName>lwsitpepufak697750.gcdn.ntruss.com</defaultDomainName>
          <userDomainName></userDomainName>
        </globalCdnServiceDomain>
      </globalCdnServiceDomainList>
      <globalCdnRule>
        <protocolTypeCode>HTTP</protocolTypeCode>
        <serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
        <originUrl>1.255.57.58</originUrl>
        <originPath></originPath>
        <originHttpPort>80</originHttpPort>
        <originHttpsPort>0</originHttpsPort>
        <forwardHostHeaderTypeCode>ORIGIN_HOSTNAME</forwardHostHeaderTypeCode>
        <forwardHostHeader></forwardHostHeader>
        <cacheKeyHostNameTypeCode>REQUEST_HOST_HEADER</cacheKeyHostNameTypeCode>
        <isGzipCompressionUse>true</isGzipCompressionUse>
        <cachingOptionTypeCode>CACHE_CONTROL_AND_EXPIRES</cachingOptionTypeCode>
        <isErrorContentsResponseUse>false</isErrorContentsResponseUse>
        <cachingTtlTime>604800</cachingTtlTime>
        <isQueryStringIgnoreUse>true</isQueryStringIgnoreUse>
        <isRemoveVaryHeaderUse>true</isRemoveVaryHeaderUse>
        <isLargeFileOptimizationUse>false</isLargeFileOptimizationUse>
        <gzipResponseTypeCode>ORIGIN_RESPONSE</gzipResponseTypeCode>
        <isReferrerDomainUse>false</isReferrerDomainUse>
        <referrerDomainList/>
        <isReferrerDomainRestrictUse>false</isReferrerDomainRestrictUse>
        <isSecureTokenUse>true</isSecureTokenUse>
        <secureTokenPassword>fe835ae5110388224220</secureTokenPassword>
        <isReissueSecureTokenPassword>false</isReissueSecureTokenPassword>
        <isAccessLogUse>true</isAccessLogUse>
        <accessLogFileStorageContainerName>cdnlogtest</accessLogFileStorageContainerName>
        <isRequestCustomHeaderUse>false</isRequestCustomHeaderUse>
        <requestCustomHeaderList/>
        <isResponseCustomHeaderUse>false</isResponseCustomHeaderUse>
        <responseCustomHeaderList/>
      </globalCdnRule>
    </globalCdnInstance>
  </globalCdnInstanceList>
</getGlobalCdnInstanceListResponse>

Error codes

Error code	Description
29100	Invalid Global CDN rule format.
29101	Cannot operate this Global CDN service. Please check status.
29102	Invalid Global CDN purge request.
29103	Invalid Global CDN service domain type code.
29104	Please enter Forward Host Header.
29105	Invalid Origin server.
29106	Invalid Origin server ports.
29107	Invalid Origin File Storage.
29108	Please enter Referrer Domain.
29109	Invalid service name.
29110	Please enter service domain.
29111	Invalid service domain.
29112	Invalid Global CDN instance.
29113	Only HTTP protocol is allowed when Origin is File Storage.
29114	This domain cannot set as origin.
29115	For HTTPS protocol, only CDN domain can be set.
29116	An error occurred in purge request.
29117	Invalid origin path.
29118	Invalid referrer domain.
29119	Invalid rule for access log.
29120	Invalid Forward Host Header.
29121	Referrer Domains can be added up to 50.
29122	Cannot request purge for the CDN service. Please check status.
29123	The purge function can only be used after about 3 hours after the creation request is made.
29124	There is an error in the service domain name entered during the purge request.

Was this article helpful?

What's Next

getGlobalCdnMonitoringData

Table of contents

Overview
Request
Response
Properties
Examples
Error codes