getCdnPlusInstanceList

Article Summary

Share feedback

Thanks for sharing your feedback!

Overview

Get CDN instance domain list

Description

Gets the domain ID and information of a CDN instance created.

Request Parameters

Parameter	Required	Type	Restrictions	Description
cdnInstanceNo	No	String	-	If a CDN instance number is not specified, the API returns all instances and domains created in the account. If a CDN instance number is specified, the API returns only domains of the instance.
pageNo	No	Integer	Min:0, Max:2147483647	Page number for pagination if the number of CDN instances to get is large. If it is set to 0 by default, all instances are displayed.
pageSize	No	Integer	Min:0, Max:2147483647	Number of instances to be shown on a page if the number of CDN instances to get is large. If it is set to 0 by default, all instances are displayed.

Response Data Type

CdnPlusInstanceList type

CdnPlusInstanceList extends CommonResponse
private Integer totalRows;
private List cdnPlusInstanceList = new ArrayList();

CdnPlusInstance
private String cdnInstanceNo;
private CommonCode cdnInstanceStatus;
private CommonCode cdnInstanceOperation;
private String cdnInstanceStatusName;
private String createDate;
private String lastModifiedDate;
private String cdnInstanceDescription;
private String serviceName;
private Boolean isForLiveTranscoder;
private List liveTranscoderInstanceNoList;
private Boolean isAvailablePartialDomainPurge;
private List cdnPlusServiceDomainList;
private CdnPlusRule cdnPlusRule;

Examples

Request

ncloud cdn getCdnPlusInstanceList --cdnInstanceNo 456400

Response

{
  "getCdnPlusInstanceListResponse": {
    "requestId": "f56c997c-2d4f-464b-bfff-2728e4c52191",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "cdnPlusInstanceList": [
      {
        "cdnInstanceNo": "456400",
        "cdnInstanceStatus": {
          "code": "RUN",
          "codeName": "Server run state"
        },
        "cdnInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "cdnInstanceStatusName": "running",
        "createDate": "2017-08-30T22:33:52+0900",
        "lastModifiedDate": "2017-09-19T11:34:46+0900",
        "cdnInstanceDescription": "",
        "serviceName": "real-qa-custom02",
        "isForLiveTranscoder": false,
        "liveTranscoderInstanceNoList": [],
        "isForImageOptimizer": false,
        "imageOptimizerInstanceNo" : "",
        "isAvailablePartialDomainPurge": true,
        "cdnPlusServiceDomainList": [
          {
            "domainId": "CD000000000000006580",
            "serviceDomainTypeCode": "USER",
            "protocolTypeCode": "HTTP",
            "defaultDomainName": "qhytwoxdervh456400.cdn.ntruss.com",
            "userDomainName": "ncp-cdn.a.navercdn.com"
          },
          {
            "domainId": "CD000000000000006581",
            "serviceDomainTypeCode": "USER",
            "protocolTypeCode": "HTTP",
            "defaultDomainName": "piytcmfpkjvy456400.cdn.ntruss.com",
            "userDomainName": "ncp-cdn.b.navercdn.com"
          },
          {
            "domainId": "CD000000000000006585",
            "serviceDomainTypeCode": "USER",
            "protocolTypeCode": "HTTP",
            "defaultDomainName": "bamupnqrzjwh456400.cdn.ntruss.com",
            "userDomainName": "ncp-cdn.c.navercdn.com"
          }
        ],
        "cdnPlusRule": {
          "protocolTypeCode": "HTTP",
          "serviceDomainTypeCode": "USER",
          "originUrl": "ncp-cdn.origin.navercdn.com",
          "originPath": "",
          "originHttpPort": 80,
          "originHttpsPort": 0,
          "forwardHostHeaderTypeCode": "REQUEST_HOST_HEADER",
          "forwardHostHeader": "",
          "cacheKeyHostNameTypeCode": "REQUEST_HOST_HEADER",
          "isGzipCompressionUse": true,
          "cachingOptionTypeCode": "CACHE_CONTROL_MAX_AGE",
          "isErrorContentsResponseUse": false,
          "cachingTtlTime": 604800,
          "isQueryStringIgnoreUse": true,
          "isRemoveVaryHeaderUse": true,
          "isLargeFileOptimizationUse": false,
          "gzipResponseTypeCode": "ORIGIN_RESPONSE",
          "isReferrerDomainUse": false,
          "referrerDomainList": [],
          "isReferrerDomainRestrictUse": false,
          "isSecureTokenUse": false,
          "secureTokenPassword": "",
          "isReissueSecureTokenPassword": false,
          "certificateName": "",
          "isAccessLogUse": false,
          "accessLogFileStorageContainerName": "",
          "isRequestCustomHeaderUse" : false,
          "requestCustomHeaderList" : [],
          "isResponseCustomHeaderUse" : false,
          "responseCustomHeaderList" : []
        }
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<getCdnPlusInstanceListResponse>
  <requestId>f56c997c-2d4f-464b-bfff-2728e4c52191</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cdnPlusInstanceList>
    <cdnInstanceNo>456400</cdnInstanceNo>
    <cdnInstanceStatus>
      <code>RUN</code>
      <codeName>Server run state</codeName>
    </cdnInstanceStatus>
    <cdnInstanceOperation>
      <code>NULL</code>
      <codeName>Server NULL OP</codeName>
    </cdnInstanceOperation>
    <cdnInstanceStatusName>running</cdnInstanceStatusName>
    <createDate>2017-08-30T22:33:52+0900</createDate>
    <lastModifiedDate>2017-09-19T11:34:46+0900</lastModifiedDate>
    <cdnInstanceDescription></cdnInstanceDescription>
    <serviceName>real-qa-custom02</serviceName>
    <isForLiveTranscoder>false</isForLiveTranscoder>
    <liveTranscoderInstanceNoList/>
    <isForImageOptimizer>false</isForImageOptimizer>
    <imageOptimizerInstanceNo></imageOptimizerInstanceNo>
    <isAvailablePartialDomainPurge>true</isAvailablePartialDomainPurge>
    <cdnPlusServiceDomainList>
      <domainId>CD000000000000006580</domainId>
      <serviceDomainTypeCode>USER</serviceDomainTypeCode>
      <protocolTypeCode>HTTP</protocolTypeCode>
      <defaultDomainName>qhytwoxdervh456400.cdn.ntruss.com</defaultDomainName>
      <userDomainName>ncp-cdn.a.navercdn.com</userDomainName>
    </cdnPlusServiceDomainList>
    <cdnPlusServiceDomainList>
      <domainId>CD000000000000006581</domainId>
      <serviceDomainTypeCode>USER</serviceDomainTypeCode>
      <protocolTypeCode>HTTP</protocolTypeCode>
      <defaultDomainName>piytcmfpkjvy456400.cdn.ntruss.com</defaultDomainName>
      <userDomainName>ncp-cdn.b.navercdn.com</userDomainName>
    </cdnPlusServiceDomainList>
    <cdnPlusServiceDomainList>
      <domainId>CD000000000000006585</domainId>
      <serviceDomainTypeCode>USER</serviceDomainTypeCode>
      <protocolTypeCode>HTTP</protocolTypeCode>
      <defaultDomainName>bamupnqrzjwh456400.cdn.ntruss.com</defaultDomainName>
      <userDomainName>ncp-cdn.c.navercdn.com</userDomainName>
    </cdnPlusServiceDomainList>
    <cdnPlusRule>
      <protocolTypeCode>HTTP</protocolTypeCode>
      <serviceDomainTypeCode>USER</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>false</isReferrerDomainUse>
      <referrerDomainList/>
      <isReferrerDomainRestrictUse>false</isReferrerDomainRestrictUse>
      <isSecureTokenUse>false</isSecureTokenUse>
      <secureTokenPassword></secureTokenPassword>
      <isReissueSecureTokenPassword>false</isReissueSecureTokenPassword>
      <certificateName></certificateName>
      <isAccessLogUse>false</isAccessLogUse>
      <accessLogFileStorageContainerName></accessLogFileStorageContainerName>
      <isRequestCustomHeaderUse>false</isRequestCustomHeaderUse>
      <requestCustomHeaderList/>
      <isResponseCustomHeaderUse>false</isResponseCustomHeaderUse>
      <responseCustomHeaderList/>
    </cdnPlusRule>
  </cdnPlusInstanceList>
</getCdnPlusInstanceListResponse>

Was this article helpful?

What's Next

getCdnPlusPurgeHistoryList

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples