MENU
      requestGlobalCdnPurge

        requestGlobalCdnPurge


        Article summary

        Overview

        Requests global CDN purge.

        Request

        Request parameters

        ParameterRequiredTypeLimitationsDescription
        cdnInstanceNoYStringCDN instance number
        isWholeDomainYBooleantrue or falseIndicates whether to purge all domains.
        Enter true for purge requests for the entire domain, false for purge requests for the specific domain.
        serviceDomainNameList.NNList<String>List of service domain names
        Enter for purge requests for a specific domain.
        ex) serviceDomainNameList.1=sample.example.com&serviceDomainNameList.2=test.example.com
        isWholePurgeYBooleantrue or falseIndicates whether to purge all content.
        Enter true for purge requests for the entire file or false for purge requests for the specific file.
        The entire purge request cannot specify the service domain.
        targetFileList.NNList<String>List of files to purge
        Enter for purge request of a specific file.
        ex) targetFileList.1=alice.txt&targetFileList.2=bob.png
        responseFormatTypeNStringJSON or XMLResponse type

        Response

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

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

        Properties

        PropertyRequiredTypeDescription
        cdnInstanceNoNStringCDN instance number
        purgeIdNStringPurge ID
        isWholePurgeNBooleanIndicates whether to purge all content.
        isWholeDomainNBooleanIndicates whether to purge all domains.
        globalCdnServiceDomainListNList<GlobalCdnServiceDomain>List of global CDN service domains
        serviceDomainTypeCodeNStringService domain type code
        protocolTypeCodeNStringProtocol type code
        defaultDomainNameNStringDefault domain name
        userDomainNameNStringUser domain name
        targetFileListNList<String>List of files to purge
        estimatedCompletionDateNStringEstimated completion date
        isSuccessNBooleanIndicates whether it is successful.
        requestDateNStringRequest date

        Examples

        Request example

        https://ncloud.apigw.ntruss.com/cdn/v2/requestGlobalCdnPurge?cdnInstanceNo=697750&isWholePurge=true&isWholeDomain=true&responseFormatType=XML
        HTTP

        Response example

        <?xml version="1.0" encoding="UTF-8"?>
        <requestGlobalCdnPurgeResponse>
          <requestId>847f09c8-54c7-4cdf-ad20-fa7608673f1d</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <globalCdnPurgeHistoryList>
            <globalCdnPurgeHistory>
              <cdnInstanceNo>697750</cdnInstanceNo>
              <purgeId>ed2b6b63-fb0b-11e8-bd53-196c5d109cd0</purgeId>
              <isWholePurge>true</isWholePurge>
              <isWholeDomain>true</isWholeDomain>
              <globalCdnServiceDomainList>
                <globalCdnServiceDomain>
                  <serviceDomainTypeCode>DEFAULT</serviceDomainTypeCode>
                  <protocolTypeCode>HTTP</protocolTypeCode>
                  <defaultDomainName>lwsitpepufak697750.gcdn.ntruss.com</defaultDomainName>
                  <userDomainName></userDomainName>
                </globalCdnServiceDomain>
              </globalCdnServiceDomainList>
              <targetFileList/>
              <estimatedCompletionDate>2018-12-09T02:12:46+0900</estimatedCompletionDate>
              <isSuccess>true</isSuccess>
              <requestDate>2018-12-09T02:08:46+0900</requestDate>
            </globalCdnPurgeHistory>
          </globalCdnPurgeHistoryList>
        </requestGlobalCdnPurgeResponse>
        XML

        Error codes

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

        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.