requestCdnPlusPurge

概要

CDN Purgeリクエスト

説明

CDN特定インスタンスに対して全体ファイル、ディレクトリ単位、個別ファイルに対するPurgeを実行するAPIです。

リクエストパラメータ

パラメータ名	必須	タイプ	制約事項	説明
cdnInstanceNo	Yes	String	-	Purgeを実行する対象CDNインスタンス番号を入力します。
domainIdList	No	List	-	CDNインスタンス内Purgeを実行するDomainリストを入力します。
isWholePurge	Yes	Boolean	-	CDNインスタンス内キャッシュされたすべてのコンテンツをPurgeする場合、'true'を入力します。全体Purgeを実行する場合、原本にリクエスト/トラフィックの増加で負荷が発生する可能性があるため、使うことはお勧めしません。
isWholeDomain	Yes	Boolean	インスタンス情報と一致必要	CDNインスタンス内すべてのDomainに対してPurgeする場合、'true'を入力します。 CDNインスタンス情報を照会する時、'isAvailablePartialDomainPurge'の値が'false'である場合には'true'のみを入力する必要があります。
targetFileList	No	String	Max:100個	個別ファイル単位Purgeを実行する時、対象のファイルリストを入力します。ファイルは一度に100個までのみ実行できます。
targetDirectoryName	No	String	-	ディレクトリPurge実行を行う時、対象のディレクトリ名を入力します。

レスポンスデータタイプ

CdnPurgeHistoryListタイプ

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;

例示

呼び出し

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

レスポンス

{
  "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>