getCdnPlusInstanceList
    • PDF

    getCdnPlusInstanceList

    • PDF

    Article summary

    Overview

    Gets a list of CDN+ instances.

    Request

    Request parameters

    ParameterRequiredTypeLimitationsDescription
    cdnInstanceNoNStringCDN instance number
    pageNoNIntegerMin: 0,
    Max: 2147483647
    Page number based on the page size if the number of items is large.
    pageSizeNIntegerMin: 0,
    Max: 2147483647
    Number of items to be shown per page
    responseFormatTypeNStringJSON or XMLResponse type

    Response

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

    HTTP status codeCode messageDescription
    200SuccessSucceeded
    401UnauthorizedAuthentication failed
    500Internal Server ErrorServer error

    Properties

    PropertyRequiredTypeDescription
    cdnInstanceNoNStringCDN instance number
    cdnInstanceStatusNCommonCodeCDN instance status
    cdnInstanceStatusNCommonCodeCDN instance status
    cdnInstanceStatusNameNStringCDN instance status name
    createDateNStringCreation date
    lastModifiedDateNStringUPTIME
    cdnInstanceDescriptionNStringCDN instance description
    serviceNameNStringService name
    isForLiveTranscoderNBooleanIndicates whether it is a live transcoder.
    liveTranscoderInstanceNoListNList<String>List of live transcoder instance numbers
    isForImageOptimizerNBooleanIndicates whether it is an ImageOptimizer.
    imageOptimizerInstanceNoNStringList of ImageOptimizer instance numbers
    isAvailablePartialDomainPurgeNBoolean
    cdnPlusServiceDomainListNList<CdnPlusServiceDomain>List of CDN+ service domains
    domainIdNStringDomain ID
    serviceDomainTypeCodeNStringService domain type code
    protocolTypeCodeNStringProtocol type code
    defaultDomainNameNStringDefault domain name
    userDomainNameNStringUser domain name
    cdnPlusRuleNCdnPlusRuleCDN 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 codeDescription
    29200Invalid CDN rule.
    29201Cannot operate this CDN service. Please check status.
    29202Invalid CDN purge request.
    29203Invalid CDN service domain type code.
    29204Invalid CDN instance.
    29205Unable to control the CDN service because this CDN service is for Live Transcoder.
    29211An error occurred while creating CDN service.
    29215This CDN service cannot request purge with partial domains.
    29216Invalid CDN service domain.
    29209The certificate cannot register for CDN.
    29217Please enter target file list or directory.
    29218Please select target service domains.
    29221Unable to control the CDN service because this CDN service is for Image Optimizer.
    29222Invalid image optimizer instance number.
    29223Cache Key Hostname cannot be set Origin Hostname if there is only one service domain.
    29224Cache Key Hostname cannot be set Origin Hostname if use CDN domain.

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.