Overview

Request CDN Purge

Description

Purges a specific file, a directory or all files of a CDN instance.

Request Parameters

Parameter	Required	Type	Restrictions	Description
cdnInstanceNo	Yes	String		CDN instance number you want to purge.
domainIdList	No	List		List of domains you want to purge in the CDN instance.
isWholePurge	Yes	Boolean		Specify this parameter to "true," if you want to purge all content cached in the CDN instance. It is not recommended to purge all content because increased requests and traffic can cause a problem in the source.
isWholeDomain	Yes	Boolean	Restricted by instance information.	Specify this parameter to "true," if you want to purge all domains in the CDN instance. You should set this to "true," if "isAvailablePartialDomainPurge" is "false" when you get CDN instance information.
targetFileList	No	String	Max: 100	List of files you want to purge. You can purge up to 100 files at once.
targetDirectoryName	No	String		Name of a directory you want to purge.

Response Data Type

CdnPurgeHistoryList type

CdnPlusPurgeHistoryList extends CommonResponse
private Integer totalRows;
private List cdnPlusPurgeHistoryList = new ArrayList();

cdnPlusPurgeHistory
private String cdnInstanceNo;
private String purgeId;
private Boolean isWholePurge;
private Boolean isWholeDomain;
private List cdnPlusServiceDomainList;
private String targetDirectoryName;
private List targetFileList;
private Date requestDate;
private String purgeStatusName;

Examples

Request

ncloud cdn requestCdnPlusPurge --cdnInstanceNo 456400 --isWholePurge true --isWholeDomain true

Response

{
  "requestCdnPlusPurgeResponse": {
    "requestId": "927ce830-934f-42e5-9202-5b34c20b372f",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 3,
    "cdnPlusPurgeHistoryList": [
      {
        "cdnInstanceNo": "456400",
        "purgeId": "PT000000000000001510",
        "isWholePurge": true,
        "isWholeDomain": true,
        "cdnPlusServiceDomainList": [
          {
            "domainId": "CD000000000000006585",
            "serviceDomainTypeCode": "USER",
            "protocolTypeCode": "HTTP",
            "defaultDomainName": "bamupnqrzjwh456400.cdn.ntruss.com",
            "userDomainName": "ncp-cdn.c.navercdn.com"
          }
        ],
        "targetDirectoryName": "",
        "targetFileList": [],
        "requestDate": "2018-02-27T23:33:20+0900",
        "purgeStatusName": "ready"
      },
      {
        "cdnInstanceNo": "456400",
        "purgeId": "PT000000000000001509",
        "isWholePurge": true,
        "isWholeDomain": true,
        "cdnPlusServiceDomainList": [
          {
            "domainId": "CD000000000000006581",
            "serviceDomainTypeCode": "USER",
            "protocolTypeCode": "HTTP",
            "defaultDomainName": "piytcmfpkjvy456400.cdn.ntruss.com",
            "userDomainName": "ncp-cdn.b.navercdn.com"
          }
        ],
        "targetDirectoryName": "",
        "targetFileList": [],
        "requestDate": "2018-02-27T23:33:20+0900",
        "purgeStatusName": "ready"
      },
      {
        "cdnInstanceNo": "456400",
        "purgeId": "PT000000000000001508",
        "isWholePurge": true,
        "isWholeDomain": true,
        "cdnPlusServiceDomainList": [
          {
            "domainId": "CD000000000000006580",
            "serviceDomainTypeCode": "USER",
            "protocolTypeCode": "HTTP",
            "defaultDomainName": "qhytwoxdervh456400.cdn.ntruss.com",
            "userDomainName": "ncp-cdn.a.navercdn.com"
          }
        ],
        "targetDirectoryName": "",
        "targetFileList": [],
        "requestDate": "2018-02-27T23:33:20+0900",
        "purgeStatusName": "ready"
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<requestCdnPlusPurgeResponse>
  <requestId>927ce830-934f-42e5-9202-5b34c20b372f</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>3</totalRows>
  <cdnPlusPurgeHistoryList>
    <cdnInstanceNo>456400</cdnInstanceNo>
    <purgeId>PT000000000000001510</purgeId>
    <isWholePurge>true</isWholePurge>
    <isWholeDomain>true</isWholeDomain>
    <cdnPlusServiceDomainList>
      <domainId>CD000000000000006585</domainId>
      <serviceDomainTypeCode>USER</serviceDomainTypeCode>
      <protocolTypeCode>HTTP</protocolTypeCode>
      <defaultDomainName>bamupnqrzjwh456400.cdn.ntruss.com</defaultDomainName>
      <userDomainName>ncp-cdn.c.navercdn.com</userDomainName>
    </cdnPlusServiceDomainList>
    <targetDirectoryName></targetDirectoryName>
    <targetFileList/>
    <requestDate>2018-02-27T23:33:20+0900</requestDate>
    <purgeStatusName>ready</purgeStatusName>
  </cdnPlusPurgeHistoryList>
  <cdnPlusPurgeHistoryList>
    <cdnInstanceNo>456400</cdnInstanceNo>
    <purgeId>PT000000000000001509</purgeId>
    <isWholePurge>true</isWholePurge>
    <isWholeDomain>true</isWholeDomain>
    <cdnPlusServiceDomainList>
      <domainId>CD000000000000006581</domainId>
      <serviceDomainTypeCode>USER</serviceDomainTypeCode>
      <protocolTypeCode>HTTP</protocolTypeCode>
      <defaultDomainName>piytcmfpkjvy456400.cdn.ntruss.com</defaultDomainName>
      <userDomainName>ncp-cdn.b.navercdn.com</userDomainName>
    </cdnPlusServiceDomainList>
    <targetDirectoryName></targetDirectoryName>
    <targetFileList/>
    <requestDate>2018-02-27T23:33:20+0900</requestDate>
    <purgeStatusName>ready</purgeStatusName>
  </cdnPlusPurgeHistoryList>
  <cdnPlusPurgeHistoryList>
    <cdnInstanceNo>456400</cdnInstanceNo>
    <purgeId>PT000000000000001508</purgeId>
    <isWholePurge>true</isWholePurge>
    <isWholeDomain>true</isWholeDomain>
    <cdnPlusServiceDomainList>
      <domainId>CD000000000000006580</domainId>
      <serviceDomainTypeCode>USER</serviceDomainTypeCode>
      <protocolTypeCode>HTTP</protocolTypeCode>
      <defaultDomainName>qhytwoxdervh456400.cdn.ntruss.com</defaultDomainName>
      <userDomainName>ncp-cdn.a.navercdn.com</userDomainName>
    </cdnPlusServiceDomainList>
    <targetDirectoryName></targetDirectoryName>
    <targetFileList/>
    <requestDate>2018-02-27T23:33:20+0900</requestDate>
    <purgeStatusName>ready</purgeStatusName>
  </cdnPlusPurgeHistoryList>
</requestCdnPlusPurgeResponse>

Was this article helpful?

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples
- Request
- Response