In order to provide detailed descriptions of the various NAVER CLOUD PLATFORM services, and to facilitate use of various APIs, we offer [Manual] and [API reference] separately.

Server API overview

NAVER CLOUD PLATFORM is a cloud service built with NAVER's latest computing technology and operational know-how. NAVER CLOUD PLATFORM provides a set of application programming interfaces (APIs) which allows you to use some solution products among its various product categories. NAVER CLOUD PLATFORM APIs are RESTful, using HTTP GET/POST methods.

Common

  • {SERVER_API_URL}
https://ncloud.apigw.ntruss.com/server/v1
  • Request header
Header Description
x-ncp-apigw-timestamp It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference with the APIGW server is more than 5 minutes, the request is considered invalid.
x-ncp-apigw-api-key API key issued by API Gateway
x-ncp-iam-access-key API key issued by NAVER CLOUD PLATFORM or access key issued by IAM
x-ncp-apigw-signature-v1 Signature used to encrypt the body of the example with the “secret key” that maps with the “access key.”
The HMAC encryption algorithm is HMAC SHA256.

API References


Product

Basically, you can use NAVER CLOUD PLATFORM on a product basis. Therefore, in order to create a server instance (VM), you should purchase a server image and server after viewing those products.

getServerImageProductList

  • API name

    Get server image product list

  • action

    getServerImageProductList

  • Description

    To create a server instance (VM), you should select a server image. This API gets a list of server images.

  • Request parameters

Parameter Brief Description Type Limitations Required
exclusionProductCode Product code to exclude String Min: 1, Max: 20 No
productCode Product code to get String Min: 1, Max: 20 No
platformTypeCodeList.N Platform identification code list List\ Min: 1, Max: 5 No
blockStorageSize Block storage size Integer No
regionNo Region number String No
infraResourceDetailTypeCode Infra resource detail type code String No
  • exclusionProductCode
    • Product code you want to exclude from the list.
  • productCode
    • Product code you want to view on the list. Use this when searching for 1 product.
  • platformTypeCodeList.N
  • Values required for identifying platforms in list-type.
  • The available values are as follows:
    • Linux 32Bit(LNX32) | Linux 64Bit(LNX64) | Windows 32Bit(WND32) | Windows 64Bit(WND64) | Ubuntu Desktop 64Bit(UBD64) | Ubuntu Server 64Bit(UBS64)
  • blockStorageSize
    • Default: 50 | 100
  • regionNo

    • Get available values using the getRegionList action.
  • Example

    • Request

       ${SERVER_API_URL}/getServerImageProductList
       ?platformTypeCodeList.1=LNX64
       &platformTypeCodeList.2=WND64
      
    • Response

      <getServerImageProductListResponse>
           <requestId>bf4d5bd2-587f-4e1e-8ac3-f7fb0e6cde03</requestId>
           <returnCode>0</returnCode>
           <returnMessage>success</returnMessage>
           <productList>
               <product>
                   <productCode>SPSW0LINUX000010</productCode>
                   <productName>centos-5.7-64</productName>
                   <productType>
                       <code>LINUX</code>
                       <codeName>Linux</codeName>
                   </productType>
                   <productDescription>CentOS 5.7(64bit)</productDescription>
                   <infraResourceType>
                       <code>SW</code>
                       <codeName>Software</codeName>
                   </infraResourceType>
                   <cpuCount>0</cpuCount>
                   <memorySize>0</memorySize>
                   <baseBlockStorageSize>0</baseBlockStorageSize>
                   <platformType>
                       <code>LNX64</code>
                         <codeName>Linux 64 Bit</codeName>
                     </platformType>
                   <osInformation>CentOS 5.7 64Bit</osInformation>
                   <addBlockStroageSize>0</addBlockStroageSize>
               </product>
           </productList>
      </getServerImageProductListResponse>
      

getServerProductList

  • API name

    Get server product list

  • Action

    getServerProductList

  • Description

    To create a server instance (VM), you should select a server (server specs).
    This API gets a list of servers.

  • Request parameters

Parameter Brief Description Type Limitations Required
exclusionProductCode Product code to exclude String Min: 1, Max: 20 No
productCode Product code to get String Min: 1, Max: 20 No
serverImageProductCode Server image product code String Min: 1, Max: 20 Yes
regionNo Region number String No
zoneNo Zone number String No
internetLineTypeCode Internet line type code String Min:1, Max:5 No
  • exclusionProductCode
    • Product code you want to exclude from the list.
  • productCode
    • Product code you want to view on the list. Use this when searching for 1 product.
  • serverImageProductCode
    • Get available values using the getServerImageProdutList action. It is required, and the available server specs depend on the selected server image.
  • regionNo
    • Get available values using the getRegionList action.
  • zoneNo
    • Zone from which you want to get a list of products.
    • Get available values using the getZoneList action.
    • Default: The first zone of the region.
  • internetLineTypeCode

    • Internet line type code
    • PUBLC (Public), GLBL (Global)
    • Default: PUBLC (Public)
  • Example

    • Request

       ${SERVER_API_URL}/getServerProductList
       ?serverImageProductCode=SPSW0LINUX000031
      
    • Response

      <getServerProductListResponse>
      <requestId>12ae51b2-0624-4522-98e1-f41fd475e7f6</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <productList>
          <product>
              <productCode>SPSVRSTAND000043</productCode>
              <productName>[Local Disk] 2 vCPUs, 4GB memory, 100GB disk</productName>
              <productType>
                  <code>STAND</code>
                  <codeName>Standard</codeName>
              </productType>
              <productDescription>
              [Local Disk] 2 vCPUs, 4GB memory, 100GB disk
              </productDescription>
              <infraResourceType>
                  <code>SVR</code>
                  <codeName>Server</codeName>
              </infraResourceType>
              <cpuCount>2</cpuCount>
              <memorySize>4294967296</memorySize>
              <baseBlockStorageSize>53687091200</baseBlockStorageSize>
              <osInformation/>
              <diskType>
                  <code>LOCAL</code>
                  <codeName>Local storage</codeName>
              </diskType>
              <addBlockStroageSize>53687091200</addBlockStroageSize>
          </product>
          <product>
              <productCode>SPSVRSTAND000028</productCode>
              <productName>[Local Disk] 4 vCPUs, 8GB memory, 200GB disk</productName>
              <productType>
                  <code>STAND</code>
                  <codeName>Standard</codeName>
              </productType>
              <productDescription>
               [Local Disk] 4 vCPUs, 8GB memory, 200GB disk
              </productDescription>
              <infraResourceType>
                  <code>SVR</code>
                  <codeName>Server</codeName>
              </infraResourceType>
              <cpuCount>4</cpuCount>
              <memorySize>8589934592</memorySize>
              <baseBlockStorageSize>53687091200</baseBlockStorageSize>
              <osInformation/>
              <diskType>
                  <code>LOCAL</code>
                  <codeName>Local storage</codeName>
              </diskType>
              <addBlockStroageSize>161061273600</addBlockStroageSize>
          </product>
          <product>
              <productCode>SPSVRSTAND000029</productCode>
              <productName>[Local Disk] 8 vCPUs, 16GB memory, 400GB disk</productName>
              <productType>
                  <code>STAND</code>
                  <codeName>Standard</codeName>
              </productType>
              <productDescription>
                  [Local Disk] 8 vCPUs, 16GB memory, 400GB disk</productDescription>
              <infraResourceType>
                  <code>SVR</code>
                  <codeName>Server</codeName>
              </infraResourceType>
              <cpuCount>8</cpuCount>
              <memorySize>17179869184</memorySize>
              <baseBlockStorageSize>53687091200</baseBlockStorageSize>
              <osInformation/>
              <diskType>
                  <code>LOCAL</code>
                  <codeName>Local storage</codeName>
              </diskType>
              <addBlockStroageSize>375809638400</addBlockStroageSize>
          </product>
      </productList>
      </getServerProductListResponse>
      

Zone

Server instances (VMs) can be created in a zone provided by NAVER CLOUD PLATFORM. Basically, zones are distinguished by Distribution Switch (DS).

getZoneList

  • API name

    Get zone list

  • Action

    getZoneList

  • Description

    You can create a server instance (VM) in a specified zone. This API gets a list of zones provided by NAVER CLOUD PLATFORM.

  • Request parameters

Parameter Brief Description Type Limitations Required
regionNo Region number String No
  • regionNo

    • Get available values using the getRegionList action.
  • Example

    • Request

      ${SERVER_API_URL}/getZoneList
      
    • Request

      <getZoneListResponse>
          <requestId>cb437d90-6f9a-4c74-944d-d09d90a89ca8</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <zoneList>
              <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>zone2</zoneName>
                  <zoneDescription>nang zone</zoneDescription>
              </zone>
          </zoneList>
      </getZoneListResponse>
      

Region

getRegionList

  • API name

    Get region list

  • Action

    getRegionList

  • Description

    Gets a list of available regions.

  • Example

    • Request

      ${SERVER_API_URL}/getRegionList
      
    • Response

      <getRegionListResponse>
          <requestId>d7e36dd2-3461-444e-89c7-7cae42215ac6</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>3</totalRows>
          <regionList>
              <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
              </region>
          </regionList>
      </getRegionListResponse>
      

NAS

createNasVolumeInstance

  • API name

    Create NAS volume instance

  • Action

    createNasVolumeInstance

  • Description

    Creates a NAS volume instance.

  • Request parameters
Parameter Brief Description Type Limitations Required
volumeName Volume name String Yes
volumeSize NAS volume size String 500 - 10000 GB Yes
volumeAllotmentProtocolTypeCode Volume allotment protocol type code String Min: 1, Max: 5 Yes
serverInstanceNoList.N Server instance number list List\ No
customIpList.N Custom IP list List\ No
cifsUserName CIFS user name String Conditional
cifsUserPassword CIFS user password String Conditional
nasVolumeDescription NAS volume description String Min: 1, Max: 1000 No
regionNo Region number String Min: 1, Max: 5 No
zoneNo Zone number String No
  • volumeName
    • Name of a NAS volume to create
    • Enter a volume name that can be 3-20 characters in length after the name already entered for user identification.
  • volumeSize
    • NAS volume size The volume size can be 500-10,000 GB, in increments of 100 GB.
  • volumeAllotmentProtocolTypeCode
    • Volume allotment protocol type code
    • NFS | CIFS
    • NFS: You can mount the volume in a Linux server such as CentOS and Ubuntu.
    • CIFS: You can mount the volume in a Windows server.
  • serverInstanceNoList
    • List of server instance numbers for which access to NFS is to be controlled
  • customIpList
    • To add a server of another account to the NAS volume, enter a private IP address of the server.
  • cifsUserName
    • CIFS user name
    • The ID must contain a combination of English alphabet and numbers, which can be 6-20 characters in length.
  • cifsUserPassword
    • CIFS user password
    • The password must contain a combination of at least 2 English letters, numbers and special characters, which can be 8-14 characters in length.
  • nasVolumeDescription
    • NAS volume description
  • regionNo
    • Get available values using the getRegionList action.
    • Default: KR region
  • zoneNo

    • Zone in which you want to create a NAS volume.
    • Get available values using the getZoneList action.
    • Default: The first zone of the region.
  • Example

    • Request

      ${SERVER_API_URL}/createNasVolumeInstance
      &volumeSize=600
      
    • Response

      <createNasVolumeInstanceResponse>
          <requestId>58574752-49cb-411f-8710-e0fc6c28b8a7</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <nasVolumeInstanceList>
              <nasVolumeInstance>
                  <nasVolumeInstanceNo>397767</nasVolumeInstanceNo>
                  <nasVolumeInstanceStatus>
                      <code>CREAT</code>
                      <codeName>NAS create</codeName>
                  </nasVolumeInstanceStatus>
                  <nasVolumeInstanceOperation>
                      <code>NULL</code>
                      <codeName>NAS NULL OP</codeName>
                  </nasVolumeInstanceOperation>
                  <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
                  <createDate>2018-02-27T13:13:05+0900</createDate>
                  <nasVolumeInstanceDescription />
                  <mountInformation>10.105.84.82:/n000212_penguin</mountInformation>
                  <volumeAllotmentProtocolType>
                      <code>NFS</code>
                      <codeName>NFS</codeName>
                  </volumeAllotmentProtocolType>
                  <volumeName>n000212_penguin</volumeName>
                  <volumeTotalSize>536870912000</volumeTotalSize>
                  <volumeSize>536870912000</volumeSize>
                  <volumeUseSize>258048</volumeUseSize>
                  <volumeUseRatio>0.0</volumeUseRatio>
                  <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
                  <snapshotVolumeSize>0</snapshotVolumeSize>
                  <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
                  <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
                  <isSnapshotConfiguration>false</isSnapshotConfiguration>
                  <isEventConfiguration>false</isEventConfiguration>
                  <region>
                      <regionNo>1</regionNo>
                      <regionCode>KR</regionCode>
                      <regionName>Korea</regionName>
                  </region>
                  <zone>
                      <zoneNo>2</zoneNo>
                      <zoneName>KR-1</zoneName>
                      <zoneCode>KR-1</zoneCode>
                      <zoneDescription>KR-1 zone</zoneDescription>
                      <regionNo>1</regionNo>
                  </zone>
                  <nasVolumeInstanceCustomIpList />
                  <nasVolumeServerInstanceList />
              </nasVolumeInstance>
          </nasVolumeInstanceList>
      </createNasVolumeInstanceResponse>
      

deleteNasVolumeInstance

  • API name

    Delete NAS volume instance

  • Action

    deleteNasVolumeInstance

  • Description

    Deletes a NAS volume instance.

  • Request parameters

Parameter Brief Description Type Limitations Required
nasVolumeInstanceNo NAS volume instance number String Yes
  • Example

    • Request

      ${SERVER_API_URL}/deleteNasVolumeInstance
      &nasVolumeInstance=397767
      
    • Response

      <deleteNasVolumeInstanceResponse>
          <requestId>d131a03a-ecc4-407d-88d9-059911b34f74</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <nasVolumeInstanceList>
              <nasVolumeInstance>
                  <nasVolumeInstanceNo>397767</nasVolumeInstanceNo>
                  <nasVolumeInstanceStatus>
                      <code>CREAT</code>
                      <codeName>NAS create</codeName>
                  </nasVolumeInstanceStatus>
                  <nasVolumeInstanceOperation>
                      <code>NULL</code>
                      <codeName>NAS NULL OP</codeName>
                  </nasVolumeInstanceOperation>
                  <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
                  <createDate>2018-02-27T13:13:05+0900</createDate>
                  <nasVolumeInstanceDescription />
                  <mountInformation>10.105.84.82:/n000212_penguin</mountInformation>
                  <volumeAllotmentProtocolType>
                      <code>NFS</code>
                      <codeName>NFS</codeName>
                  </volumeAllotmentProtocolType>
                  <volumeName>n000212_penguin</volumeName>
                  <volumeTotalSize>547608330240</volumeTotalSize>
                  <volumeSize>547608330240</volumeSize>
                  <volumeUseSize>258048</volumeUseSize>
                  <volumeUseRatio>0.0</volumeUseRatio>
                  <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
                  <snapshotVolumeSize>0</snapshotVolumeSize>
                  <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
                  <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
                  <isSnapshotConfiguration>false</isSnapshotConfiguration>
                  <isEventConfiguration>false</isEventConfiguration>
                  <region>
                      <regionNo>1</regionNo>
                      <regionCode>KR</regionCode>
                      <regionName>Korea</regionName>
                  </region>
                  <zone>
                      <zoneNo>2</zoneNo>
                      <zoneName>KR-1</zoneName>
                      <zoneCode>KR-1</zoneCode>
                      <zoneDescription>KR-1 zone</zoneDescription>
                      <regionNo>1</regionNo>
                  </zone>
                  <nasVolumeInstanceCustomIpList />
                  <nasVolumeServerInstanceList />
              </nasVolumeInstance>
          </nasVolumeInstanceList>
      </deleteNasVolumeInstanceResponse>
      

getNasVolumeInstanceList

  • API name

    Get NAS volume instance list

  • Action

    getNasVolumeInstanceList

  • Description

    Gets a list of NAS volume instances.

  • Request parameters
Parameter Brief Description Type Limitations Required
volumeAllotmentProtocolTypeCode Volume allotment protocol type code String Min: 1, Max: 5 No
isEventConfiguration Indicates whether an event is configured. Boolean No
isSnapshotConfiguration Indicates whether a snapshot volume is configured. Boolean No
regionNo Region number String No
zoneNo Zone Number String No
  • volumeAllotmentProtocolTypeCode
    • Volume allotment protocol type code
    • NFS | CIFS
    • All volume instances will be selected if the filter is not specified.
  • isEventConfiguration
    • Indicates whether the event is set
    • true | false
    • All volume instances will be selected if the filter is not specified.
  • isSnapshotConfiguration
    • Indicates whether a snapshot volume is set.
    • true | false
    • All volume instances will be selected if the filter is not specified.
  • regionNo
    • Available status will be shown by getRegionList action.
    • default : KR
  • zoneNo

    • Filters NasVolumeInstanceList.
    • All zones in the region will be selected if the filter is not specified.
  • Example

    • Request

      ${SERVER_API_URL}/getNasVolumeInstanceList
      
    • Response

      <nasVolumeInstanceListResponse>
          <requestId>8d8434da-f69f-4675-837c-b570e4567795</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <nasVolumeInstanceList>
              <nasVolumeInstance>
                  <nasVolumeInstanceNo>327798</nasVolumeInstanceNo>
                  <nasVolumeInstanceStatus>CREAT</nasVolumeInstanceStatus>
                  <createDate>Mon Jun 12 22:16:56 KST 2017</createDate>
                  <nasVolumeInstanceDescription />
                  <serviceIP>10.99.67.199</serviceIP>
                  <volumeAllotmentProtocol>NFS</volumeAllotmentProtocol>
                  <volumeName>n000203_nangtest01</volumeName>
                  <volumeTotalSize>53687091200</volumeTotalSize>
                  <volumeSize>53687091200</volumeSize>
                  <volumeUseSize>344064</volumeUseSize>
                  <volumeUseRatio>0.0</volumeUseRatio>
                  <snapshotVolumeSize>0</snapshotVolumeSize>
                  <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
                  <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
                  <isSnapshot>false</isSnapshot>
                  <isEvent>true</isEvent>
                  <nasVolumeInstanceCustomIpList>
                      <nasVolumeInstanceCustomIp>
                          <customIp>10.113.177.15</customIp>
                      </nasVolumeInstanceCustomIp>
                  </nasVolumeInstanceCustomIpList>
                  <nasVolumeServerInstanceList>
                      <nasVolumeServerInstance>
                          <serverInstanceNo>321332</serverInstanceNo>
                          <serverName>svr-9ae8ae0ae0f8ad2</serverName>
                          <ip>10.113.177.14</ip>
                          <instanceStatus>NSTOP</instanceStatus>
                          <instanceStatusName>terminating</instanceStatusName>
                      </nasVolumeServerInstance>
                  </nasVolumeServerInstanceList>
              </nasVolumeInstance>
          </nasVolumeInstanceList>
      </nasVolumeInstanceListResponse>
      

changeNasVolumeSize

  • API name

    Change NAS volume size

  • Action

    changeNasVolumeSize

  • Description

    Changes the size of the NAS volume.

  • Request parameters

Parameter Brief Description Type Limitations Required
nasVolumeInstanceNo NAS volume instance number String Yes
volumeSize NAS volume size Integer 500 - 10000 GB Yes
  • nasVolumeInstanceNo
    • NAS volume instance number
    • Get available values using the getNasVolumeInstanceList action.
  • volumeSize

    • NAS volume size
    • At least 500 GB | up to 10000 GB
  • Example

    • Request

      ${SERVER_API_URL}/changeNasVolumeSize
      ?nasVolumeInstanceNo=327798
      &volumeSize=600
      
    • Response

      <nasVolumeInstanceResponse>
          <requestId>454727b1-fffb-46c7-aa81-d849caf61b02</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <nasVolumeInstanceList>
              <nasVolumeInstance>
                  <nasVolumeInstanceNo>327798</nasVolumeInstanceNo>
                  <nasVolumeInstanceStatus>CREAT</nasVolumeInstanceStatus>
                  <createDate>Mon Jun 12 22:16:56 KST 2017</createDate>
                  <nasVolumeInstanceDescription />
                  <serviceIP>10.99.67.199</serviceIP>
                  <volumeAllotmentProtocol>NFS</volumeAllotmentProtocol>
                  <volumeName>n000203_nangtest01</volumeName>
                  <volumeTotalSize>32212254720</volumeTotalSize>
                  <volumeSize>32212254720</volumeSize>
                  <volumeUseSize>344064</volumeUseSize>
                  <volumeUseRatio>0.0</volumeUseRatio>
                  <snapshotVolumeSize>0</snapshotVolumeSize>
                  <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
                  <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
                  <isSnapshot>false</isSnapshot>
                  <isEvent>true</isEvent>
                  <nasVolumeInstanceCustomIpList>
                      <nasVolumeInstanceCustomIp>
                          <customIp>10.113.177.15</customIp>
                      </nasVolumeInstanceCustomIp>
                  </nasVolumeInstanceCustomIpList>
                  <nasVolumeServerInstanceList>
                      <nasVolumeServerInstance>
                          <serverInstanceNo>321332</serverInstanceNo>
                          <serverName>svr-9ae8ae0ae0f8ad2</serverName>
                          <ip>10.113.177.14</ip>
                          <instanceStatus>NSTOP</instanceStatus>
                          <instanceStatusName>terminating</instanceStatusName>
                      </nasVolumeServerInstance>
                  </nasVolumeServerInstanceList>
              </nasVolumeInstance>
          </nasVolumeInstanceList>
      </nasVolumeInstanceResponse>
      

getNasVolumeInstanceRatingList

  • API name

    Get NAS volume instance rating list

  • Action

    getNasVolumeInstanceRatingList

  • Description

    Gets the size of the NAS volume instance periodically (date/hour/minute/second).

  • Request parameters

Parameter Brief Description Type Limitations Required
nasVolumeInstanceNo NAS volume instance number String Yes
startTime Rating start time String yyyy-MM-dd'T'HH:mm:ssZ format Yes
endTime Rating end time String yyyy-MM-dd'T'HH:mm:ssZ format Yes
interval Rating interval String 5m / 6h / 1d / 1M Yes
  • nasVolumeInstanceNo
    • NAS volume instance number
    • Get available values using the getNasVolumeInstanceList action.
  • startTime
    • Rating start time
    • yyyy-MM-dd'T'HH:mm:ssZ format (GMT)
    • Example) 2017-07-20T00:00:00+0900 (KST)
    • Data retention period: 5 minutes: 3 days | 6 hours: 1 month | 1 day: 2 years | 1 month: 5 years
  • endTime
    • Rating end time
    • yyyy-MM-dd'T'HH:mm:ssZ format (GMT)
    • Example) 2017-07-20T00:00:00+0900 (KST)
    • Data retention period: 5 minutes: 3 days | 6 hours: 1 month | 1 day: 2 years | 1 month: 5 years
  • interval

    • Rating interval
    • 5 minutes (5m) | 6 hours (6h) | 1 days (1d) | 1 month (1M)
  • Example

    • Request

      ${SERVER_API_URL}/getNasVolumeInstanceRatingList
      ?nasVolumeInstanceNo=327798
      &startTime=2017-07-21T00:00:00+0900
      &endTime=2017-07-22T00:00:00+0900
      &interval=1d
      
    • Response

      <nasVolumeInstanceRatingListResponse>
          <requestId>f678d447-7e93-4f3f-9cfe-35e9ea221bdc</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>2</totalRows>
          <NasVolumeInstanceRatingList>
              <nasVolumeInstanceRating>
                  <ratingTime>20170721</ratingTime>
                  <averageVolumeSize>32212254720</averageVolumeSize>
                  <averageVolumeUsedSize>347989</averageVolumeUsedSize>
                  <averageVolumeUsedRatio>0.0</averageVolumeUsedRatio>
                  <maxVolumeUsedSize>348160</maxVolumeUsedSize>
                  <maxVolumeUsedRatio>0.0</maxVolumeUsedRatio>
                  <minVolumeUsedSize>344064</minVolumeUsedSize>
                  <minVolumeUsedRatio>0.0</minVolumeUsedRatio>
                  <snapshotAverageVolumeSize>0</snapshotAverageVolumeSize>
                  <snapshotAverageVolumeUsedSize>0</snapshotAverageVolumeUsedSize>
                  <snapshotMaxVolumeUsedSize>0</snapshotMaxVolumeUsedSize>
                  <snapshotMaxVolumeUsedRatio>0.0</snapshotMaxVolumeUsedRatio>
                  <snapshotMinVolumeUsedSize>0</snapshotMinVolumeUsedSize>
                  <snapshotMinVolumeUsedRatio>0.0</snapshotMinVolumeUsedRatio>
              </nasVolumeInstanceRating>
          </NasVolumeInstanceRatingList>
      </nasVolumeInstanceRatingListResponse>
      

setNasVolumeAccessControl

  • API name

    Set NAS volume instance access control

  • Action

    setNasVolumeAccessControl

  • Description

    Sets access control for NAS volumes.

  • Request parameters

Parameter Brief Description Type Limitations Required
nasVolumeInstanceNo NAS volume instance number String Yes
serverInstanceNoList Server instance number list List\ Duplicates not allowed. No
customIpList Custom IP list List\ Duplicates not allowed. No
  • nasVolumeInstanceNo
    • NAS volume instance number
    • Get available values using the getNasVolumeInstanceList action.
  • serverInstanceNoList
    • Duplicates not allowed.
    • Only the instance numbers of your own servers are available.
  • customIpList

    • Duplicates not allowed.
    • Only private IP addresses are allowed. (Public IP addresses are not allowed.)
  • Example

    • Request
    ${SERVER_API_URL}/setNasVolumeAccessControl
    ?nasVolumeInstanceNo=327798
    &serverInstanceNoList.1=321346
    &customIpList.1=10.101.6.74
    
    • Response
    <nasVolumeInstanceListResponse>
        <requestId>a83bad7b-1be8-4293-a3ce-37fc4117f96e</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <nasVolumeInstanceList>
            <nasVolumeInstance>
                <nasVolumeInstanceNo>327798</nasVolumeInstanceNo>
                <nasVolumeInstanceStatus>
                    <code>CREAT</code>
                    <codeName>NAS create</codeName>
                </nasVolumeInstanceStatus>
                <nasVolumeInstanceOperation>
                    <code>NULL</code>
                    <codeName>NAS NULL OP</codeName>
                </nasVolumeInstanceOperation>
                <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
                <createDate>2017-06-12T22:16:56+0900</createDate>
                <nasVolumeInstanceDescription />
                <mountInformation>10.99.67.199:/vol/n000203_nangtest01</mountInformation>
                <volumeAllotmentProtocolType>
                    <code>NFS</code>
                    <codeName>NFS</codeName>
                </volumeAllotmentProtocolType>
                <volumeName>n000203_nangtest01</volumeName>
                <volumeTotalSize>32212254720</volumeTotalSize>
                <volumeSize>32212254720</volumeSize>
                <volumeUseSize>348160</volumeUseSize>
                <volumeUseRatio>0.0</volumeUseRatio>
                <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
                <snapshotVolumeSize>0</snapshotVolumeSize>
                <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
                <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
                <isSnapshotConfiguration>false</isSnapshotConfiguration>
                <isEventConfiguration>true</isEventConfiguration>
                <nasVolumeInstanceCustomIpList>
                    <nasVolumeInstanceCustomIp>
                        <customIp>10.101.6.74</customIp>
                    </nasVolumeInstanceCustomIp>
                </nasVolumeInstanceCustomIpList>
                <nasVolumeServerInstanceList>
                    <serverInstance>
                        <serverInstanceNo>321346</serverInstanceNo>
                        <serverName>glorytestcentos5</serverName>
                        <serverDescription>dasd</serverDescription>
                        <cpuCount>1</cpuCount>
                        <memorySize>2147483648</memorySize>
                        <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                        <platformType>
                            <code>LNX64</code>
                            <codeName>Linux 64 Bit</codeName>
                        </platformType>
                        <loginKeyName>asdq</loginKeyName>
                        <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                        <publicIp />
                        <privateIp>10.99.137.240</privateIp>
                        <serverImageName>centos-5.11-64</serverImageName>
                        <serverInstanceStatus>
                            <code>NSTOP</code>
                            <codeName>Server normal stopped state</codeName>
                        </serverInstanceStatus>
                        <serverInstanceOperation>
                            <code>NULL</code>
                            <codeName>Server NULL OP</codeName>
                        </serverInstanceOperation>
                        <serverInstanceStatusName>stopped</serverInstanceStatusName>
                        <createDate>2017-03-24T16:19:06+0900</createDate>
                        <uptime>2017-03-24T16:22:55+0900</uptime>
                        <serverImageProductCode>SPSW0LINUX000043</serverImageProductCode>
                        <serverProductCode>SPSVRSTAND000003</serverProductCode>
                        <isProtectServerTermination>false</isProtectServerTermination>
                        <portForwardingPublicIp>192.168.120.127</portForwardingPublicIp>
                        <zone>
                            <zoneNo>2</zoneNo>
                            <zoneName>KR-1</zoneName>
                            <zoneDescription>KR-1 zone</zoneDescription>
                        </zone>
                        <region>
                            <regionNo>1</regionNo>
                            <regionCode>KR</regionCode>
                            <regionName>KOREA</regionName>
                        </region>
                        <baseBlockStorageDiskType>
                            <code>NET</code>
                            <codeName>Network Storage</codeName>
                        </baseBlockStorageDiskType>
                        <baseBlockStroageDiskDetailType>
                            <code>HDD</code>
                            <codeName>HDD</codeName>
                        </baseBlockStroageDiskDetailType>
                        <internetLineType>
                            <code>PUBLC</code>
                            <codeName>PUBLC</codeName>
                        </internetLineType>
                        <userData />
                        <accessControlGroupList>
                            <accessControlGroup>
                                <accessControlGroupConfigurationNo>1035</accessControlGroupConfigurationNo>
                                <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                                <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                                <isDefault>true</isDefault>
                                <createDate>2013-12-03T10:37:23+0900</createDate>
                            </accessControlGroup>
                        </accessControlGroupList>
                    </serverInstance>
                </nasVolumeServerInstanceList>
            </nasVolumeInstance>
        </nasVolumeInstanceList>
    </nasVolumeInstanceListResponse>
    

addNasVolumeAccessControl

  • API name

    Add NAS volume instance access control

  • Action

    addNasVolumeAccessControl

  • Description

    Adds access control for NAS volumes.

  • Request parameters

Parameter Brief Description Type Limitations Required
nasVolumeInstanceNo NAS volume instance number String Yes
serverInstanceNoList Server instance number list List\ Duplicates not allowed. No
customIpList Cusom IP list List\ Duplicates not allowed. No
  • nasVolumeInstanceNo
    • NAS volume instance number
    • Get available values using the getNasVolumeInstanceList action.
  • serverInstanceNoList
    • Duplicates not allowed.
    • Only the instance numbers of your own servers are available.
  • customIpList

    • Duplicates not allowed.
    • Only private IP addresses are allowed. (Public IP addresses are not allowed.)
  • Example

    • Request

      ${SERVER_API_URL}/addNasVolumeAccessControl
      ?nasVolumeInstanceNo=327798
      &serverInstanceNoList.1=321346
      &customIpList.1=10.101.6.74
      
    • Response

      <nasVolumeInstanceListResponse>
          <requestId>a83bad7b-1be8-4293-a3ce-37fc4117f96e</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <nasVolumeInstanceList>
              <nasVolumeInstance>
                  <nasVolumeInstanceNo>327798</nasVolumeInstanceNo>
                  <nasVolumeInstanceStatus>
                      <code>CREAT</code>
                      <codeName>NAS create</codeName>
                  </nasVolumeInstanceStatus>
                  <nasVolumeInstanceOperation>
                      <code>NULL</code>
                      <codeName>NAS NULL OP</codeName>
                  </nasVolumeInstanceOperation>
                  <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
                  <createDate>2017-06-12T22:16:56+0900</createDate>
                  <nasVolumeInstanceDescription />
                  <mountInformation>10.99.67.199:/vol/n000203_nangtest01</mountInformation>
                  <volumeAllotmentProtocolType>
                      <code>NFS</code>
                      <codeName>NFS</codeName>
                  </volumeAllotmentProtocolType>
                  <volumeName>n000203_nangtest01</volumeName>
                  <volumeTotalSize>32212254720</volumeTotalSize>
                  <volumeSize>32212254720</volumeSize>
                  <volumeUseSize>348160</volumeUseSize>
                  <volumeUseRatio>0.0</volumeUseRatio>
                  <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
                  <snapshotVolumeSize>0</snapshotVolumeSize>
                  <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
                  <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
                  <isSnapshotConfiguration>false</isSnapshotConfiguration>
                  <isEventConfiguration>true</isEventConfiguration>
                  <nasVolumeInstanceCustomIpList>
                      <nasVolumeInstanceCustomIp>
                          <customIp>10.101.6.74</customIp>
                      </nasVolumeInstanceCustomIp>
                  </nasVolumeInstanceCustomIpList>
                  <nasVolumeServerInstanceList>
                      <serverInstance>
                          <serverInstanceNo>321346</serverInstanceNo>
                          <serverName>glorytestcentos5</serverName>
                          <serverDescription>dasd</serverDescription>
                          <cpuCount>1</cpuCount>
                          <memorySize>2147483648</memorySize>
                          <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                          <platformType>
                              <code>LNX64</code>
                              <codeName>Linux 64 Bit</codeName>
                          </platformType>
                          <loginKeyName>asdq</loginKeyName>
                          <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                          <publicIp />
                          <privateIp>10.99.137.240</privateIp>
                          <serverImageName>centos-5.11-64</serverImageName>
                          <serverInstanceStatus>
                              <code>NSTOP</code>
                              <codeName>Server normal stopped state</codeName>
                          </serverInstanceStatus>
                          <serverInstanceOperation>
                              <code>NULL</code>
                              <codeName>Server NULL OP</codeName>
                          </serverInstanceOperation>
                          <serverInstanceStatusName>stopped</serverInstanceStatusName>
                          <createDate>2017-03-24T16:19:06+0900</createDate>
                          <uptime>2017-03-24T16:22:55+0900</uptime>
                          <serverImageProductCode>SPSW0LINUX000043</serverImageProductCode>
                          <serverProductCode>SPSVRSTAND000003</serverProductCode>
                          <isProtectServerTermination>false</isProtectServerTermination>
                          <portForwardingPublicIp>192.168.120.127</portForwardingPublicIp>
                          <zone>
                              <zoneNo>2</zoneNo>
                              <zoneName>KR-1</zoneName>
                              <zoneDescription>KR-1 zone</zoneDescription>
                          </zone>
                          <region>
                              <regionNo>1</regionNo>
                              <regionCode>KR</regionCode>
                              <regionName>KOREA</regionName>
                          </region>
                          <baseBlockStorageDiskType>
                              <code>NET</code>
                              <codeName>Network Storage</codeName>
                          </baseBlockStorageDiskType>
                          <baseBlockStroageDiskDetailType>
                              <code>HDD</code>
                              <codeName>HDD</codeName>
                          </baseBlockStroageDiskDetailType>
                          <internetLineType>
                              <code>PUBLC</code>
                              <codeName>PUBLC</codeName>
                          </internetLineType>
                          <userData />
                          <accessControlGroupList>
                              <accessControlGroup>
                                  <accessControlGroupConfigurationNo>1035</accessControlGroupConfigurationNo>
                                  <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                                  <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                                  <isDefault>true</isDefault>
                                  <createDate>2013-12-03T10:37:23+0900</createDate>
                              </accessControlGroup>
                          </accessControlGroupList>
                      </serverInstance>
                  </nasVolumeServerInstanceList>
              </nasVolumeInstance>
          </nasVolumeInstanceList>
      </nasVolumeInstanceListResponse>
      

removeNasVolumeAccessControl

  • API name

    Remove NAS volume instance access control

  • Action

    removeNasVolumeAccessControl

  • Description

    Removes access control for NAS volumes.

  • Request parameters

Parameter Brief Description Type Limitations Required
nasVolumeInstanceNo NAS volume instance number String Yes
serverInstanceNoList Server instance number list List\ Duplicates not allowed. No
customIpList Cusom IP list List\ Duplicates not allowed. No
  • nasVolumeInstanceNo
    • NAS volume instance number
    • Get available values using the getNasVolumeInstanceList action.
  • serverInstanceNoList
    • Duplicates not allowed.
    • Only the instance numbers of your own servers are available.
  • customIpList

    • Duplicates not allowed.
    • Only private IP addresses are allowed. (Public IP addresses are not allowed.)
  • Example

    • Request

      ${SERVER_API_URL}/removeNasVolumeAccessControl
      ?nasVolumeInstanceNo=327798
      &serverInstanceNoList.1=321346
      
    • Response

      <nasVolumeInstanceListResponse>
          <requestId>11474f55-8cac-4ae3-8bf0-2e88f04a7d82</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <nasVolumeInstanceList>
              <nasVolumeInstance>
                  <nasVolumeInstanceNo>327798</nasVolumeInstanceNo>
                  <nasVolumeInstanceStatus>
                      <code>CREAT</code>
                      <codeName>NAS create</codeName>
                  </nasVolumeInstanceStatus>
                  <nasVolumeInstanceOperation>
                      <code>NULL</code>
                      <codeName>NAS NULL OP</codeName>
                  </nasVolumeInstanceOperation>
                  <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
                  <createDate>2017-06-12T22:16:56+0900</createDate>
                  <nasVolumeInstanceDescription />
                  <mountInformation>10.99.67.199:/vol/n000203_nangtest01</mountInformation>
                  <volumeAllotmentProtocolType>
                      <code>NFS</code>
                      <codeName>NFS</codeName>
                  </volumeAllotmentProtocolType>
                  <volumeName>n000203_nangtest01</volumeName>
                  <volumeTotalSize>32212254720</volumeTotalSize>
                  <volumeSize>32212254720</volumeSize>
                  <volumeUseSize>348160</volumeUseSize>
                  <volumeUseRatio>0.0</volumeUseRatio>
                  <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
                  <snapshotVolumeSize>0</snapshotVolumeSize>
                  <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
                  <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
                  <isSnapshotConfiguration>false</isSnapshotConfiguration>
                  <isEventConfiguration>true</isEventConfiguration>
                  <nasVolumeInstanceCustomIpList>
                      <nasVolumeInstanceCustomIp>
                          <customIp>10.101.6.74</customIp>
                      </nasVolumeInstanceCustomIp>
                  </nasVolumeInstanceCustomIpList>
                  <nasVolumeServerInstanceList />
              </nasVolumeInstance>
          </nasVolumeInstanceList>
      </nasVolumeInstanceListResponse>
      

Login key

getLoginKeyList

  • API name

    Get login key list

  • Action

    getLoginKeyList

  • Description

    When creating a server instance (VM) and logging in to it, you should use a login key to get the key that encrypts and decrypts a password.

  • Request parameters

Parameter Brief Description Type Limitations Required
keyName Key name String Min: 3, Max: 30 No
pageNo Page number Integer Min: 0, Max:2147483647 No
pageSize Page size Integer Min: 0, Max: 2147483647 No
  • keyName
    • Name of a key you want to get
  • pageNo
    • Page number based on the page size if the number of items is large.
  • pageSize

    • Number of items to be shown per page
  • Example

    • Request

      ${SERVER_API_URL}/getLoginKeyList
      
    • Response

      <getLoginKeyListResponse>
      <requestId>23c7e367-4d17-403a-beb9-8e4644624bf0</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>18</totalRows>
      <loginKeyList>
          <loginKey>
          <fingerprint>0e:d4:3e:ce:4b:18:75:d3:2a:03:ae:2a:df:ea:7a:e8</fingerprint>
          <keyName>yh-nang-test</keyName>
          <createDate>2014-02-03T11:33:53+0900</createDate>
          </loginKey></loginKeyList>
      </getLoginKeyListResponse>
      

createLoginKey

  • API name

    Create login key

  • Action

    createLoginKey

  • Description

    When creating a server instance (VM) and logging in to it, you should use a login key to create a key that encrypts and decrypts a password.

  • Request parameters

Parameter Brief Description Type Limitations Required
keyName Key name String Min: 3, Max: 30 Yes
  • keyName

    • Name of a key you want to create
    • If the same key name already exists, an error occurs.
  • Example

    • Request

      ${SERVER_API_URL}/createLoginKey
      ?keyName=mykey
      
    • Response

      <createLoginKeyResponse>
      <requestId>2f4b95a0-555c-4e64-a47f-cb5aa289e1d7</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <privateKey>
      -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEAtNkTS9cHBLXQcDY0s02KqaLb8GGupaeCLvWzNDM3aVZxUDFo kZYaEKFXbWhR1oZ4HyZnwo4y1VDxV1m35Ltq/HRCHP8+caNHaM6n2rivfHT8nMxg KvzsXjopWIVp+8oHvmi0TO+zcEusoNOv/jb7LcJwfeZ0WQvianQ7j6ppaXgHfZSX Tdqwyuf9UmzppUa8f2wLslDOlcYQW6VQ9S5f9cx9HgTXbc4vlb+NDLwdx0E+AIjw p5PgWCjbEqGKz2Myw4X7HJ06619BScwXSkyG+G3g0VjtL7WnEhhdmfGLCUE/BcKv Fz9KeRXIQAx8NrAW4c0Vq+CPyBgz5EWWMpTUXQIDAQABAoIBABn7AXmot3pmwD4O m32SyzPZkK0060kjCmHCrG74WKKKZ5b0sigQH0h6VTwDe5ZNFR6sfsWFdioNCc7Z tcBnaFRCQ2k1Bfx/T3fwEE8srxE7ITtJZRtn4HEc++maqQIiIQCqvBQ9b1LXnEIy hxsHPQhy4YREwjw0p99ROWlHOwOKm6KWbc4YFbDKmEc9v+NLxxNjf2KF7jNuQK0l VjeJEzBa02sFBGhMeLAMvhmHj9u1NbAFUn/uC4MrMFiQMoCnx2qBSoUPxuvL6WXH NpUoLT/rJrlqKUCffS3RIVt+lwjU6vVXlrxuYNTLDH4c+XJHkFprYDdq/lZktuRM f9uYa4ECgYEA75xeol7dvFGe6Es8pcNrdZUMEwkVR16DER+nfndl3fJMNu1YIBaf XKnDZLjS505pP+a0alwq0aQdXY8FIik9O9ugqpnd1EfI2fMlrVynUOcBIhVbvYip PNFg+tIuz37f3vMms7NCQ5W3SlincB63ptl2tovkOjXKbo1r1sZaGf0CgYEAwTfB wqvGm1GpMv8jrCFGNS7FXxZy5VcP/APXqfQb6Lpwe4rarxfb8nnap5KYOn0qSbY7 BOoidV6QysT9Xm3pDjNUoeH9CujK0mx3sL/4utZiCqmVhGljGq9D4A7PsCnT4X4+ Akvk9L9RS+xNs9NsK8jTz9zthaJRUzhAHcWSAeECgYEA7rUvqj8sVBJUZ0OdFd8L zUZBky03X7SOip6odNtqRqS+vPHTG5SuCtitakifBAUf4aNrFZLgrZ38C1sSWCgR cvKoq41Ca9tgA5GydXWa0oRwoo34qWfeglJtdTOzos/ZI/nFEr2BRGeBBLYxiQdx Gu4G0HGpWzx/gYeuaXeOB9kCgYBEKznPRu+RSORbO60IQ80TYmb8P11WELtw/KIQ MjHOkEizLbAt6ksNZ3R/frb6m8JZs1NrTnfN1QlcoNeLg1egTPflDWhLewpj5yTr VS+aK5z3ihFYYB45AfD+kfswefFpMzMJeGFVAFLcaIiZk1QstnQUeCvM5BGxPL1S Q6xZwQKBgQCSeU8FRIa0jUxN7hx5R1+IAIBPl2JUM7bMME9T3eX3Qh6wNCMjTxse NU70sp2m+8sv7Bq4QY5P13Cajo/+fwI1BSa83mF2kXnyEpXsrfw+4FM74YTrX0JA FlSDMaL95g7fCSSMuM8sOqMuIBn7d7DiK2nbrez/iRsZFH2qOqusOA==
      -----END RSA PRIVATE KEY-----
      </privateKey>
      </createLoginKeyResponse>
      

deleteLoginKey

  • API name

    Delete login key

  • Action

    deleteLoginKey

  • Description

    When creating a server instance (VM) and logging in to it, you should use a login key to delete a key that encrypts and decrypts a password.

  • Request parameters

Parameter Brief Description Type Limitations Required
keyName Key name String Min: 3, Max: 30 Yes
  • keyName

    • Name of the key you want to delete
    • If the same key name already exists, an error occurs.
  • Example

    • Request

      ${SERVER_API_URL}/deleteLoginKey
      ?keyName=abc123456
      
    • Response

      <deleteLoginKeyResponse>
      <requestId>34b26878-fe42-4d8c-8061-bd74b699afb1</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      </deleteLoginKeyResponse>
      

      importLoginKey

  • API name

    Login key import

  • Action

    importLoginKey

  • Description

    Create a server instance (VM) and delete keys which encode or decode passwords using login keys when you access the created server instance. The user directly imports the public key generated by ssh-keygen

  • Request parameters

Parameter Name Brief Description Type Limit Requiredness
keyName Key name String Min:3, Max:30 Yes
publicKey public key String Yes
  • keyName
    • Key name to create
    • If there already exists a key name, an error may occur.
  • publicKey

    • The public key to import
    • The public key generated by ssh-keygen -t rsa -C "my-key" -f ~ / .ssh / my-key
  • Example

    • Request

      ${SERVER_API_URL}/importLoginKey
      ?keyName=ncloudTest
      &publicKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCfE6pQTOpsdQNsFtZpIzqDMyb8gH2XUUGe+9s8b36OO0i1SXkO8+u3/4EXYdujjIH+EKb9LzMiAXOtEUX0hI+zAlJemE+sBKPTORBb+YjLvBYb99ts3pdd7x1S/dgksyxdC6ru8KNS7heU0fARZGhCXmzI9Z6PhSqFMNQcUq14UYLNHUJYshuqHv/sjCBt3QgpMLcaBmgl6TLfdq7ZW0G/iz6V1a2q200A+Fq8Yuc0JLz6Q/xQqWi1+ehKs5y3Ow3D08NLwj8Ay/7eIXqk40oo+GqkQSVWIFV3lzJXB4Po10ZRC67RdCnyf8fYbZYzYP6trr/hItvmXDryEKFUnJgZ
      
    • Response

      <importLoginKeyResponse>
          <requestId>7f7c33d6-ce42-40c0-81a8-7df102c71d41</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <loginKeyList>
              <fingerprint>-</fingerprint>
              <keyName>ncloudTest</keyName>
              <createDate>2018-06-28T16:13:13+0900</createDate>
          </loginKeyList>
      </importLoginKeyResponse>
      

AccessControlGroup

getAccessControlGroupList

  • API name

    Get access control group list

  • Action

    getAccessControlGroupList

  • Description

    When creating a server instance (VM), you can add an access control group (ACG) that you specified to set firewalls. This API gets a list of access control groups necessary to set firewalls.

  • Request parameters

Parameter Name Brief Description Type Limitation Requiredness
accessControlGroupConfigurationNoList.N Access control group configuration No. list List\ Min:0, Max:5 No
isDefault Configuration of access control group in default group Y/N Boolean No
accessControlGroupName Access control group name String Min:3, Max:30 No
pageNo Page No. Integer Min:0, Max:2147483647 No
pageSize Page size Integer Min:0, Max:2147483647 No
  • accessControlGroupConfigurationNoList.N
    • List of ACG configuration numbers you want to get
  • isDefaultGroup
    • Indicates whether to get default groups only.
  • accessControlGroupName
    • Name of the ACG you want to get.
  • pageNo
    • Page number based on the page size if the number of items is large.
  • pageSize

    • Number of items to be shown per page
  • Example

    • Request

      ${SERVER_API_URL}/getAccessControlGroupList
      ?isDefault=true
      
    • Response

      <getAccessControlGroupListResponse>
          <requestId>0bca339a-56e8-4493-84cb-22f345268bef</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <accessControlGroupList>
              <accessControlGroup>
                  <accessControlGroupConfigurationNo>1035</accessControlGroupConfigurationNo>
                  <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                  <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                  <isDefaultGroup>true</isDefaultGroup>
                  <createDate>2013-12-03T10:37:23+0900</createDate>
              </accessControlGroup>
          </accessControlGroupList>
      </getAccessControlGroupListResponse>
      

getAccessControlGroupServerInstanceList

  • API name

    Get server instance list added to ACGs

  • Action

    getAccessControlGroupServerInstanceList

  • Description

    Gets a list of server instances with the ACG configuration number.

  • Request parameters

Parameter Brief Description Type Limitations Required
accessControlGroupConfigurationNo Access control group configuration number String Yes
  • accessControlGroupConfigurationNo

    • List of ACG configuration numbers you want to get
  • Example

    • Request

      ${SERVER_API_URL}/getAccessControlGroupServerInstanceList
      
    • Response

       <getAccessControlGroupServerInstanceListResponse>
         <requestId>f91dca58-23c8-4691-8009-e1afbc0f10e6</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>23</totalRows>
         <accessControlGroupServerInstanceList>
            <accessControlGroupServerInstance>
               <serverInstance />
            </accessControlGroupServerInstance>
            <accessControlGroupServerInstance>
               <serverInstance>
                  <serverInstanceNo>324320</serverInstanceNo>
                  <serverName>micro2</serverName>
                  <serverDescription />
                  <cpuCount>1</cpuCount>
                  <memorySize>1073741824</memorySize>
                  <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                  <platformType>
                     <code>LNX64</code>
                     <codeName>Linux 64 Bit</codeName>
                  </platformType>
                  <loginKeyName>solhee0518</loginKeyName>
                  <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                  <publicIp>192.168.120.21</publicIp>
                  <privateIp>10.113.178.207</privateIp>
                  <serverImageName>centos-5.7-64</serverImageName>
                  <serverInstanceStatus>
                     <code>NSTOP</code>
                     <codeName>Server normal stopped state</codeName>
                  </serverInstanceStatus>
                  <serverInstanceOperation>
                     <code>NULL</code>
                     <codeName>Server NULL OP</codeName>
                  </serverInstanceOperation>
                  <serverInstanceStatusName>stopped</serverInstanceStatusName>
                  <createDate>2017-05-18T19:41:21+0900</createDate>
                  <uptime>2017-05-18T19:44:37+0900</uptime>
                  <serverImageProductCode>SPSW0LINUX000010</serverImageProductCode>
                  <serverProductCode>SPSVRSTAND000056</serverProductCode>
                  <isProtectServerTermination>false</isProtectServerTermination>
                  <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
                  <zone>
                     <zoneNo>2</zoneNo>
                     <zoneName>KR-1</zoneName>
                     <zoneDescription>KR-1 zone</zoneDescription>
                  </zone>
                  <region>
                     <regionNo>1</regionNo>
                     <regionCode>KR</regionCode>
                     <regionName>KOREA</regionName>
                  </region>
                  <baseBlockStorageDiskType>
                     <code>NET</code>
                     <codeName>Network Storage</codeName>
                  </baseBlockStorageDiskType>
                  <baseBlockStroageDiskDetailType>
                     <code>HDD</code>
                     <codeName>HDD</codeName>
                  </baseBlockStroageDiskDetailType>
                  <internetLineType>
                     <code>PUBLC</code>
                     <codeName>Public</codeName>
                  </internetLineType>
                  <userData />
                  <accessControlGroupList>
                     <accessControlGroup>
                        <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                        <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                        <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                        <isDefault>true</isDefault>
                        <createDate>2013-12-03T10:37:39+0900</createDate>
                     </accessControlGroup>
                  </accessControlGroupList>
               </serverInstance>
            </accessControlGroupServerInstance>
            ....
         </accessControlGroupServerInstanceList>
      </getAccessControlGroupServerInstanceListResponse>
      

getAccessControlRuleList

  • API name

    Get access control rule list

  • Action

    getAccessControlRuleList

  • Description

    Gets a list of access control rules.

  • Request parameters

Parameter Brief Description Type Limitations Required
accessControlGroupConfigurationNo ACG configuration number String Yes
  • accessControlGroupConfigurationNo

    • List of ACG configuration numbers you want to get
  • Example

    • Request

      ${SERVER_API_URL}/getAccessControlRuleList
      
    • Response

      <getAccessControlRuleListResponse>
         <requestId>95239e27-9db0-4f38-8612-a16ba6a974f0</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <accessControlRuleList>
            <accessControlRule>
               <accessControlRuleConfigurationNo>10949</accessControlRuleConfigurationNo>
               <protocolType>
                  <code>TCP</code>
                  <codeName>tcp</codeName>
               </protocolType>
               <sourceIp />
         <sourceAccessControlRuleConfigurationNo>5390</sourceAccessControlRuleConfigurationNo>
               <destinationPort>3306-20000</destinationPort>
               <accessControlRuleDescription />
            </accessControlRule>
         </accessControlRuleList>
      </getAccessControlRuleListResponse>
      

Server

getServerInstanceList

  • API name

    Get server instance list

  • Action

    getServerInstanceList

  • Description

    Gets a list of server instances (VMs). The results can be paginated. userData is returned only when you get detailed information.

  • Request parameters

Parameter Brief Description Type Limitations Required
serverInstanceNoList.N List of server instance numbers List\ No
searchFilterName Filter name to search String No
searchFilterValue Filter value to search String No
pageNo Page number Integer Min: 0, Max: 2147483647 No
pageSize Page size Integer Min: 0, Max: 2147483647 No
serverInstanceStatusCode Server instance status code String Min: 0, Max: 5 No
internetLineTypeCode Internet line type code String Min:0, Max: 5 No
regionNo Region number String No
zoneNo Zone number String No
baseBlockStorageDiskTypeCode Server disk type code String Min: 1, Max: 5 No
baseBlockStorageDiskDetailTypeCode Detailed server disk type code String Min: 1, Max: 5 No
sortedBy Sort by String No
sortingOrder Sort order String No
serverInstanceTypeCodeList.N Serve instance type code List\ No
tagKeyList.N Tag key list List\ No
tagKeyValue.N Tag value list List\ No
  • serverInstanceNoList.N
    • List of server instance numbers you want to get
  • searchFilterName
    • Server name (serverName) | IP address (ip) [case insensitive] In the case of IP, you can search for both private and public IP addresses.
  • searchFilterValue
    • Filter value to search
  • pageNo
    • Page number based on the page size if the number of items is large.
  • pageSize
    • Number of items to be shown per page
  • serverInstanceStatusCode
    • List of servers by server instance status code you want to get
    • Please refer to the server instance status (serverInstanceStatus) of server instance data type (ServerInstance) for available status.
  • internetLineTypeCode
    • Internet line type code
    • PUBLC (Public) | GLBL (Global)
  • regionNo
    • Get available values using the getRegionList action.
  • zoneNo
    • Zone from which you want to get a list of servers.
    • Get available values using the getZoneList action.
    • Default: The first zone of the region.
  • baseBlockStorageDiskTypeCode
    • Server disk type code
    • NETWORK DISK (NET) | LOCAL DISK (LOCAL)
  • baseBlockStorageDiskDetailTypeCode
    • Detailed server disk type code
    • Hard disk (HDD) | SSD (SSD)
  • sortedBy
    • Server name (serverName) | Server instance number (serverInstanceNo) [case insensitive]
  • sortingOrder
    • Ascending (ascending) | Descending (descending) [case insensitive]
    • Default: Ascending (ascending)
  • serverInstanceTypeCodeList
    • Server instance type code list to be shown
    • Micro(MICRO) | Compact(COMPT) | Standard(STAND) | High Memory(HIMEM) | GPU(GPU) | Virtual Dedicated Server(VDS)
  • tagKeyList.N
    • Tag key list to search
  • tagValueList.N

    • Tag value list to search
  • Example

    • Request

      ${SERVER_API_URL}/getServerInstanceList
      
    • Response

      <getServerInstanceListResponse>
         <requestId>24feacf3-73dd-4e61-af59-e8fa10f3cbc3</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>31</totalRows>
         <serverInstanceList>
            <serverInstance>
               <serverInstanceNo>318672</serverInstanceNo>
               <serverName>bong-svr</serverName>
               <serverDescription />
               <cpuCount>1</cpuCount>
               <memorySize>2147483648</memorySize>
               <baseBlockStorageSize>53687091200</baseBlockStorageSize>
               <platformType>
                  <code>LNX64</code>
                  <codeName>Linux 64 Bit</codeName>
               </platformType>
               <loginKeyName>nang-eco03-psw</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp>10.101.6.111</privateIp>
               <serverImageName>centos-6.3-64</serverImageName>
               <serverInstanceStatus>
                  <code>INIT</code>
                  <codeName>Server init state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>NULL</code>
                  <codeName>Server NULL OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>init</serverInstanceStatusName>
               <createDate>2016-09-23T11:13:05+0900</createDate>
               <uptime>2016-09-23T11:17:00+0900</uptime>
               <serverImageProductCode>SPSW0LINUX000031</serverImageProductCode>
               <serverProductCode>SPSVRSTAND000003</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>KR-1 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStroageDiskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </baseBlockStroageDiskDetailType>
               <internetLineType>
                  <code>PUBLC</code>
                  <codeName>PUBLC</codeName>
               </internetLineType>
               <userData />
               <accessControlGroupList />
            </serverInstance>
            <serverInstance>
               <serverInstanceNo>324193</serverInstanceNo>
               <serverName>s-311ofyxt96gzmw001</serverName>
               <serverDescription>Auto scaling group 'asg-0207g' 소속의 자동 생성된 서버</serverDescription>
               <cpuCount>1</cpuCount>
               <memorySize>2147483648</memorySize>
               <baseBlockStorageSize>53687091200</baseBlockStorageSize>
               <platformType>
                  <code>LNX64</code>
                  <codeName>Linux 64 Bit</codeName>
               </platformType>
               <loginKeyName>hd-onlinetest03-dev</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp />
               <serverImageName>centos-6.6-64</serverImageName>
               <serverInstanceStatus>
                  <code>INIT</code>
                  <codeName>Server init state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>NULL</code>
                  <codeName>Server NULL OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>init</serverInstanceStatusName>
               <createDate>2017-05-18T11:20:29+0900</createDate>
               <uptime>2017-05-18T11:20:29+0900</uptime>
               <serverImageProductCode>SPSW0LINUX000044</serverImageProductCode>
               <serverProductCode>SPSVRSTAND000003</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>KR-1 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStroageDiskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </baseBlockStroageDiskDetailType>
               <internetLineType>
                  <code>PUBLC</code>
                  <codeName>PUBLC</codeName>
               </internetLineType>
               <userData />
               <accessControlGroupList />
            </serverInstance>
         </serverInstanceList>
      </getServerInstanceListResponse>
      

createServerInstances

  • API name

    Create server instance

  • Action

    createServerInstances

  • Description

    Creates server instances (VMs).

  • Request parameters

Parameter Name Brief Description Type Limitation Requiredness
serverImageProductCode Server image product code String Min:1, Max:20 Conditional
serverProductCode Server product code String Min:1, Max:20 No
memberServerImageNo Member server image No. String Conditional
serverName Server name String Min:3, Max:30 No
serverDescription Server description String Min:1, Max:1000 No
loginKeyName Login key name String Min:3, Max:30 No
isProtectServerTermination Termination Y/N Boolean No
serverCreateCount Number of server creation Integer Min:1, Max:20 No
serverCreateStartNo Server creation start No. Integer No
internetLineTypeCode Internet line code String Min:1, Max:5 No
feeSystemTypeCode Fee system code String Min:1, Max:5 No
zoneNo ZONE No. String No
accessControlGroupConfigurationNoList ACG configuration No. list String Min:0, Max:5 No
userData User data String Min:1, Max:21847 No
raidTypeName RAID type Name String No
instanceTagList.N.tagKey instanceTagList.N.tagKey List\ No
instanceTagList.N.tagValue instanceTagList.N.tagValue List\ No
  • serverImageProductCode
    • Server image product code to determine which server image will be created.
    • Get available values using the getServerImageProductList action.
    • Either serverImageProductCode or memberServerImageNo must be specified.
  • serverProductCode
    • Server product code to determine server specifications to be created.
    • Get available values using the getServerProductList action.
    • Default: Minimum specifications. The minimum specifications are 1. Memory 2. CPU 3. Basic block storage size 4. Disk type (NET, LOCAL)
  • memberServerImageNo
    • This value is required to create a server from a manually created server image.
    • Get available values using the getMemberServerImageList action.
  • serverName
    • Name of a server to create
    • Default: Automatically specified by Ncloud.
  • serverDescription
    • Description of a server to create
  • loginKeyName
    • Login key name to be encrypted with the public key.
    • Default: The most recently created login key.
  • isProtectServerTermination
    • Indicates whether to enable termination protection when a server is created.
    • Default: false
  • serverCreateCount
    • Number of servers that can be created at a time. You can create up to 20 servers at a time.
    • Default: 1
  • serverCreateStartNo If you create multiple servers at a time, they will be identified by adding serial numbers to each server name. You can set the starting number of the serial numbers.
    • The sum of the number of servers created and the server creation start number cannot exceed 1000.
    • Default: If the number of servers created (serverCreateCount) is greater than 1 and if serverCreateStartNo is not specified, the default value is 001.
  • internetLineTypeCode
    • Internet line type code
    • PUBLC (Public), GLBL (Global)
    • Default: PUBLC (Public)
  • feeSystemTypeCode
    • Pricing plan identification code. There are hourly plan (MTRAT) and flat sum plan (FXSUM).
    • Default: Hourly plan (MTRAT)
  • zoneNo
    • Zone where a server will be created.
    • Get available values using the getZoneList action.
    • Default: Automatically specified by NAVER CLOUD PLATFORM
  • accessControlGroupConfigurationNoList.N
    • ACG you want to set for a server.
    • Get available values using the getAccessControlGroupList action.
    • Default: Default ACG number
  • userData
    • User data script that will be executed by the server at the first boot.
    • This column is returned only when you get a single server instance.
    • The userData must be base64-encoded and URL-encoded before being specified.
    • If the base64-encoded result is not URL-encoded, a signature invalid error occurs.
    • File system script and web script, both are available.
    • ex) file://directory1/directory2/*.sh
    • ex) https://kr.objectstorage.ncloud.com/bucket/*.sh
  • raidTypeName
    • To create a bare metal server, you have to set raidTypeName value.
    • The available RAID types are available through the getRaidList action.
  • instanceTagList.N.tagKey
    • Tag key of instance tag list to create.
  • instanceTagList.N.tagValue

    • Tag value of instance tag list to create.
  • Example

    • Request

      ${SERVER_API_URL}/createServerInstances
      ?serverImageProductCode=SPSW0LINUX000032
      &serverProductCode=SPSVRSTAND000004
      
    • Response

      <createServerInstancesResponse>
         <requestId>34ea439a-6d44-474e-aa96-6e19d39dfb8a</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <serverInstanceList>
            <serverInstance>
               <serverInstanceNo>340843</serverInstanceNo>
               <serverName>svr-9b467c9f6c75360</serverName>
               <serverDescription />
               <cpuCount>2</cpuCount>
               <memorySize>4294967296</memorySize>
               <baseBlockStorageSize>53687091200</baseBlockStorageSize>
               <platformType>
                  <code>LNX32</code>
                  <codeName>Linux 32 Bit</codeName>
               </platformType>
               <loginKeyName>cloudqa</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp>10.113.178.202</privateIp>
               <serverImageName>centos-6.3-32</serverImageName>
               <serverInstanceStatus>
                  <code>INIT</code>
                  <codeName>Server init state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>NULL</code>
                  <codeName>Server NULL OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>init</serverInstanceStatusName>
               <createDate>2017-07-27T04:08:39+0900</createDate>
               <uptime>2017-07-27T04:08:39+0900</uptime>
               <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
               <serverProductCode>SPSVRSTAND000004</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>KR-1 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStroageDiskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </baseBlockStroageDiskDetailType>
               <internetLineType>
                  <code>PUBLC</code>
                  <codeName>PUBLC</codeName>
               </internetLineType>
               <userData />
               <accessControlGroupList />
            </serverInstance>
         </serverInstanceList>
      </createServerInstancesResponse>
      

recreateServerInstance

  • API name

    Recreate server instance

  • Action

    recreateServerInstance

  • Description

    recreate server instance. (Only for bare metal product)

  • Request parameters

Parameter Brief Description Type Limitations Required
serverInstanceNo Server instance number String Duplicates not allowed. Yes
serverInstanceName Server instance name String No
serverImageProductCode Server image product code to change String Yes
userData User data String Min:1, Max:21847 No
instanceTagList.N.tagKey instanceTagList.N.tagKey List\ No
instanceTagList.N.tagValue instanceTagList.N.tagValue List\ No
  • serverInstanceNo

    • Server instance number to recreate
  • serverInstanceName

    • Server instance name to recreate
    • Default : maintain previous name
  • serverImageProductCode

    • Get this parameter by using getServerImageProdutList API
    • Only bare metal server image is available.
  • instanceTagList.N.tagKey

    • Tag key of instance tag list to recreate.
  • instanceTagList.N.tagValue

    • Tag value of instance tag list to recreate.
  • Example

    • Request

      ${SERVER_API_URL}/recreateServerInstance
      ?serverInstanceNo=680744
      &changeServerImageProductCode=SPSWBMWINNT00001
      
    • Response

      <recreateServerInstanceResponse>
         <requestId>d449a2eb-60a2-4e63-b8a9-f20edec8a98c</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <serverInstanceList>
            <serverInstance>
               <serverInstanceNo>680744</serverInstanceNo>
               <serverName>penguin-window</serverName>
               <serverDescription />
               <cpuCount>20</cpuCount>
               <memorySize>137438953472</memorySize>
               <baseBlockStorageSize>4123168604160</baseBlockStorageSize>
               <platformType>
                  <code>WND64</code>
                  <codeName>Windows 64 Bit</codeName>
               </platformType>
               <loginKeyName>yoon-nang-onlinetest03-newbeta</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp>10.39.64.12</privateIp>
               <serverImageName>win-2016-64-en</serverImageName>
               <serverInstanceStatus>
                  <code>INIT</code>
                  <codeName>Server init state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>NULL</code>
                  <codeName>Server NULL OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>init</serverInstanceStatusName>
               <createDate>2018-05-30T02:12:13+0000</createDate>
               <uptime>2018-05-30T02:12:13+0000</uptime>
               <serverImageProductCode>SPSWBMWINNT00001</serverImageProductCode>
               <serverProductCode>SPSVRBM000000001</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>49.236.160.11</portForwardingPublicIp>
               <portForwardingExternalPort>30006</portForwardingExternalPort>
               <portForwardingInternalPort>3389</portForwardingInternalPort>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>가산 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>Korea</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>LOCAL</code>
                  <codeName>Local storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStorageDiskDetailType>
                  <code>SSD</code>
                  <codeName>SSD</codeName>
               </baseBlockStorageDiskDetailType>
               <serverInstanceType>
                  <code>BM</code>
                  <codeName>Bare Metal Server</codeName>
               </serverInstanceType>
               <userData>#powershell
      
      invoke-WebRequest http://125.209.192.32/ms-test/naver_download.ps1 -OutFile C:\Windows\Temp\naver_download.ps1
      C:\Windows\Temp\naver_download.ps1</userData>
               <accessControlGroupList>
                  <accessControlGroup>
                     <accessControlGroupConfigurationNo>17791</accessControlGroupConfigurationNo>
                     <accessControlGroupName>yoon-test</accessControlGroupName>
                     <accessControlGroupDescription>ttADFEDFDFD</accessControlGroupDescription>
                     <isDefault>false</isDefault>
                     <createDate>2017-09-19T02:52:24+0000</createDate>
                  </accessControlGroup>
               </accessControlGroupList>
            </serverInstance>
         </serverInstanceList>
      </recreateServerInstanceResponse>
      

terminateServerInstances

  • API name

    Terminate server instance

  • Action

    terminateServerInstances

  • Description

    Terminates server instances (VMs).

  • Request parameters
Parameter Brief Description Type Limitations Required
serverInstanceNoList Server instance number list List\ Duplicates not allowed. Yes
  • serverInstanceNoList.N List of server instance numbers to terminate

  • Request

    ${SERVER_API_URL}/terminateServerInstances
    ?serverInstanceNoList.1=340837
    
  • Response

    <terminateServerInstancesResponse>
       <requestId>1ee84982-5712-44cb-ac99-243e59dc8eb1</requestId>
       <returnCode>0</returnCode>
       <returnMessage>success</returnMessage>
       <totalRows>1</totalRows>
       <serverInstanceList>
          <serverInstance>
             <serverInstanceNo>340843</serverInstanceNo>
             <serverName>svr-9b467c9f6c75360</serverName>
             <serverDescription />
             <cpuCount>2</cpuCount>
             <memorySize>4294967296</memorySize>
             <baseBlockStorageSize>53687091200</baseBlockStorageSize>
             <platformType>
                <code>LNX32</code>
                <codeName>Linux 32 Bit</codeName>
             </platformType>
             <loginKeyName>cloudqa</loginKeyName>
             <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
             <publicIp />
             <privateIp>10.113.178.202</privateIp>
             <serverImageName>centos-6.3-32</serverImageName>
             <serverInstanceStatus>
                <code>NSTOP</code>
                <codeName>Server normal stopped state</codeName>
             </serverInstanceStatus>
             <serverInstanceOperation>
                <code>TERMT</code>
                <codeName>Server TERMINATE OP</codeName>
             </serverInstanceOperation>
             <serverInstanceStatusName>terminating</serverInstanceStatusName>
             <createDate>2017-07-27T04:08:39+0900</createDate>
             <uptime>2017-07-27T04:11:32+0900</uptime>
             <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
             <serverProductCode>SPSVRSTAND000004</serverProductCode>
             <isProtectServerTermination>false</isProtectServerTermination>
             <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
             <zone>
                <zoneNo>2</zoneNo>
                <zoneName>KR-1</zoneName>
                <zoneDescription>KR-1 zone</zoneDescription>
             </zone>
             <region>
                <regionNo>1</regionNo>
                <regionCode>KR</regionCode>
                <regionName>KOREA</regionName>
             </region>
             <baseBlockStorageDiskType>
                <code>NET</code>
                <codeName>Network Storage</codeName>
             </baseBlockStorageDiskType>
             <baseBlockStroageDiskDetailType>
                <code>HDD</code>
                <codeName>HDD</codeName>
             </baseBlockStroageDiskDetailType>
             <internetLineType>
                <code>PUBLC</code>
                <codeName>PUBLC</codeName>
             </internetLineType>
             <userData />
             <accessControlGroupList>
                <accessControlGroup>
                   <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                   <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                   <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                   <isDefaultGroup>true</isDefaultGroup>
                   <createDate>2013-12-03T10:37:39+0900</createDate>
                </accessControlGroup>
             </accessControlGroupList>
          </serverInstance>
       </serverInstanceList>
    </terminateServerInstancesResponse>
    

changeServerInstanceSpec

  • API name

    Change server instance specs

  • Action

    changeServerInstanceSpec

  • Description

    Changes server instance (VM) specifications.

  • Request parameters

Parameter Brief Description Type Limitations Required
serverInstanceNo Server instance number String Yes
serverProductCode Server product code String Min: 1, Max: 20 Yes
  • serverInstanceNo
    • Server instance number for which you want to change specifications.
  • serverProductCode

    • Product code for specifications
    • Get available values using the getServerProductList action.
  • Example

    • Request

      ${SERVER_API_URL}/changeServerInstanceSpec
      ?serverInstanceNo=340837
      &serverProductCode=SPSVRSTAND000005
      
    • Response

      <changeServerInstanceSpecResponse>
         <requestId>34ea439a-6d44-474e-aa96-6e19d39dfb8a</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <serverInstanceList>
            <serverInstance>
               <serverInstanceNo>340843</serverInstanceNo>
               <serverName>svr-9b467c9f6c75360</serverName>
               <serverDescription />
               <cpuCount>2</cpuCount>
               <memorySize>4294967296</memorySize>
               <baseBlockStorageSize>53687091200</baseBlockStorageSize>
               <platformType>
                  <code>LNX32</code>
                  <codeName>Linux 32 Bit</codeName>
               </platformType>
               <loginKeyName>cloudqa</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp>10.113.178.202</privateIp>
               <serverImageName>centos-6.3-32</serverImageName>
               <serverInstanceStatus>
                  <code>INIT</code>
                  <codeName>Server init state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>NULL</code>
                  <codeName>Server NULL OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>init</serverInstanceStatusName>
               <createDate>2017-07-27T04:08:39+0900</createDate>
               <uptime>2017-07-27T04:08:39+0900</uptime>
               <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
               <serverProductCode>SPSVRSTAND000004</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>KR-1 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStroageDiskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </baseBlockStroageDiskDetailType>
               <internetLineType>
                  <code>PUBLC</code>
                  <codeName>PUBLC</codeName>
               </internetLineType>
               <userData />
               <accessControlGroupList />
            </serverInstance>
         </serverInstanceList>
      </changeServerInstanceSpecResponse>
      

rebootServerInstances

  • API name

    Restart server instance

  • Action

    rebootServerInstances

  • Description

    Restarts server instances (VMs).

  • Request parameters
Parameter Brief Description Type Limitations Required
serverInstanceNoList Server instance number list List\ Duplicates not allowed. Yes
  • serverInstanceNoList.N

    • List of server instance numbers to restart
  • Example

    • Request

      ${SERVER_API_URL}/rebootServerInstances
      ?serverInstanceNoList.1=340598
      
    • Response

      <rebootServerInstancesResponse>
         <requestId>60b59789-a0ae-4795-b72a-621eabb8ef5f</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <serverInstanceList>
            <serverInstance>
               <serverInstanceNo>340598</serverInstanceNo>
               <serverName>zeroptest</serverName>
               <serverDescription />
               <cpuCount>2</cpuCount>
               <memorySize>4294967296</memorySize>
               <baseBlockStorageSize>53687091200</baseBlockStorageSize>
               <platformType>
                  <code>UBS64</code>
                  <codeName>Ubuntu Server 64 Bit</codeName>
               </platformType>
               <loginKeyName>cloudqa</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp>10.113.178.253</privateIp>
               <serverImageName>ubuntu-12.04-64-server</serverImageName>
               <serverInstanceStatus>
                  <code>RUN</code>
                  <codeName>Server run state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>RESTA</code>
                  <codeName>Server RESTART OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>rebooting</serverInstanceStatusName>
               <createDate>2017-07-26T11:10:29+0900</createDate>
               <uptime>2017-07-26T11:13:09+0900</uptime>
               <serverImageProductCode>SPSW0LINUX000026</serverImageProductCode>
               <serverProductCode>SPSVRSSD00000003</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>KR-1 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStroageDiskDetailType>
                  <code>SSD</code>
                  <codeName>SSD</codeName>
               </baseBlockStroageDiskDetailType>
               <internetLineType>
                  <code>PUBLC</code>
                  <codeName>PUBLC</codeName>
               </internetLineType>
               <userData />
               <accessControlGroupList>
                  <accessControlGroup>
                     <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                     <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                     <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                     <isDefaultGroup>true</isDefaultGroup>
                     <createDate>2013-12-03T10:37:39+0900</createDate>
                  </accessControlGroup>
               </accessControlGroupList>
            </serverInstance>
         </serverInstanceList>
      </rebootServerInstancesResponse>
      

startServerInstances

  • API name

    Start server instance

  • Action

    startServerInstances

  • Description

    Starts server instances (VMs).

  • Request parameters
Parameter Brief Description Type Limitations Required
serverInstanceNoList Server instance number list List\ Duplicates not allowed. Yes
  • serverInstanceNoList.N

    • List of server instance numbers to start
  • Example

    • Request

      ${SERVER_API_URL}/startServerInstances
      ?serverInstanceNoList.1=340837
      
    • Response

      <startServerInstancesResponse>
         <requestId>2a7beaae-5739-4ccd-a087-f4cd1fa6e48d</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <serverInstanceList>
            <serverInstance>
               <serverInstanceNo>340837</serverInstanceNo>
               <serverName>jin-good12</serverName>
               <serverDescription>Test</serverDescription>
               <cpuCount>4</cpuCount>
               <memorySize>8589934592</memorySize>
               <baseBlockStorageSize>53687091200</baseBlockStorageSize>
               <platformType>
                  <code>LNX64</code>
                  <codeName>Linux 64 Bit</codeName>
               </platformType>
               <loginKeyName>cloudqa</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp>10.113.178.198</privateIp>
               <serverImageName>centos-6.3-64</serverImageName>
               <serverInstanceStatus>
                  <code>NSTOP</code>
                  <codeName>Server normal stopped state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>START</code>
                  <codeName>Server START OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>booting</serverInstanceStatusName>
               <createDate>2017-07-27T03:45:55+0900</createDate>
               <uptime>2017-07-27T03:48:35+0900</uptime>
               <serverImageProductCode>SPSW0LINUX000031</serverImageProductCode>
               <serverProductCode>SPSVRSTAND000005</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>KR-1 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStroageDiskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </baseBlockStroageDiskDetailType>
               <internetLineType>
                  <code>PUBLC</code>
                  <codeName>PUBLC</codeName>
               </internetLineType>
               <userData />
               <accessControlGroupList>
                  <accessControlGroup>
                     <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                     <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                     <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                     <isDefaultGroup>true</isDefaultGroup>
                     <createDate>2013-12-03T10:37:39+0900</createDate>
                  </accessControlGroup>
               </accessControlGroupList>
            </serverInstance>
         </serverInstanceList>
      </startServerInstancesResponse>
      

stopServerInstances

  • API name

    Stop server instance

  • Action

    stopServerInstances

  • Description

    Stops server instances (VMs).

  • Request parameters
Parameter Brief Description Type Limitations Required
serverInstanceNoList Server instance number list List\ Duplicates not allowed. Yes
  • serverInstanceNoList.N

    • List of server instance numbers you want to stop
  • Example

    • Request

      ${SERVER_API_URL}/stopServerInstances
      ?serverInstanceNoList.1=67953
      
    • Response

      <stopServerInstancesResponse>
         <requestId>46c78e6b-ede6-4b76-a765-28cb8f57cebe</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <serverInstanceList>
            <serverInstance>
               <serverInstanceNo>340837</serverInstanceNo>
               <serverName>jin-good12</serverName>
               <serverDescription>Test</serverDescription>
               <cpuCount>4</cpuCount>
               <memorySize>8589934592</memorySize>
               <baseBlockStorageSize>53687091200</baseBlockStorageSize>
               <platformType>
                  <code>LNX64</code>
                  <codeName>Linux 64 Bit</codeName>
               </platformType>
               <loginKeyName>cloudqa</loginKeyName>
               <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
               <publicIp />
               <privateIp>10.113.178.198</privateIp>
               <serverImageName>centos-6.3-64</serverImageName>
               <serverInstanceStatus>
                  <code>RUN</code>
                  <codeName>Server run state</codeName>
               </serverInstanceStatus>
               <serverInstanceOperation>
                  <code>SHTDN</code>
                  <codeName>Server SHUTDOWN OP</codeName>
               </serverInstanceOperation>
               <serverInstanceStatusName>shutting down</serverInstanceStatusName>
               <createDate>2017-07-27T03:45:55+0900</createDate>
               <uptime>2017-07-27T04:20:14+0900</uptime>
               <serverImageProductCode>SPSW0LINUX000031</serverImageProductCode>
               <serverProductCode>SPSVRSTAND000005</serverProductCode>
               <isProtectServerTermination>false</isProtectServerTermination>
               <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
               <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>KR-1 zone</zoneDescription>
               </zone>
               <region>
                  <regionNo>1</regionNo>
                  <regionCode>KR</regionCode>
                  <regionName>KOREA</regionName>
               </region>
               <baseBlockStorageDiskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </baseBlockStorageDiskType>
               <baseBlockStroageDiskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </baseBlockStroageDiskDetailType>
               <internetLineType>
                  <code>PUBLC</code>
                  <codeName>PUBLC</codeName>
               </internetLineType>
               <userData />
               <accessControlGroupList>
                  <accessControlGroup>
                     <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                     <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                     <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                     <isDefaultGroup>true</isDefaultGroup>
                     <createDate>2013-12-03T10:37:39+0900</createDate>
                  </accessControlGroup>
               </accessControlGroupList>
            </serverInstance>
         </serverInstanceList>
      </stopServerInstancesResponse>
      

getRootPassword

  • API name

    Get root password

  • Action

    getRootPassword

  • Description

    Gets the password of a root account with the server's login key.

  • Request parameters
Parameter Brief Description Type Limitations Required
serverInstanceNo Server instance number String Yes
privateKey Server’s login key (auth key) String Add “\n” to get the login key as it is. Yes
  • Example

    • Request

      ${SERVER_API_URL}/getRootPassword
      ?serverInstanceNo=67953
      &privateKey=-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAtNkTS9cHBLXQcDY0s02KqaLb8GGupaeCLvWzNDM3aVZxUDFo\n kZYaEKFXbWhR1oZ4HyZnwo4y1VDxV1m35Ltq/HRCHP8+caNHaM6n2rivfHT8nMxg\n KvzsXjopWIVp+8oHvmi0TO+zcEusoNOv/jb7LcJwfeZ0WQvianQ7j6ppaXgHfZSX\n Tdqwyuf9UmzppUa8f2wLslDOlcYQW6VQ9S5f9cx9HgTXbc4vlb+NDLwdx0E+AIjw\n p5PgWCjbEqGKz2Myw4X7HJ06619BScwXSkyG+G3g0VjtL7WnEhhdmfGLCUE/BcKv\n Fz9KeRXIQAx8NrAW4c0Vq+CPyBgz5EWWMpTUXQIDAQABAoIBABn7AXmot3pmwD4O\n m32SyzPZkK0060kjCmHCrG74WKKKZ5b0sigQH0h6VTwDe5ZNFR6sfsWFdioNCc7Z\n tcBnaFRCQ2k1Bfx/T3fwEE8srxE7ITtJZRtn4HEc++maqQIiIQCqvBQ9b1LXnEIy\n hxsHPQhy4YREwjw0p99ROWlHOwOKm6KWbc4YFbDKmEc9v+NLxxNjf2KF7jNuQK0l\n VjeJEzBa02sFBGhMeLAMvhmHj9u1NbAFUn/uC4MrMFiQMoCnx2qBSoUPxuvL6WXH\n NpUoLT/rJrlqKUCffS3RIVt+lwjU6vVXlrxuYNTLDH4c+XJHkFprYDdq/lZktuRM\n f9uYa4ECgYEA75xeol7dvFGe6Es8pcNrdZUMEwkVR16DER+nfndl3fJMNu1YIBaf\n XKnDZLjS505pP+a0alwq0aQdXY8FIik9O9ugqpnd1EfI2fMlrVynUOcBIhVbvYip\n PNFg+tIuz37f3vMms7NCQ5W3SlincB63ptl2tovkOjXKbo1r1sZaGf0CgYEAwTfB\n wqvGm1GpMv8jrCFGNS7FXxZy5VcP/APXqfQb6Lpwe4rarxfb8nnap5KYOn0qSbY7\n BOoidV6QysT9Xm3pDjNUoeH9CujK0mx3sL/4utZiCqmVhGljGq9D4A7PsCnT4X4+\n Akvk9L9RS+xNs9NsK8jTz9zthaJRUzhAHcWSAeECgYEA7rUvqj8sVBJUZ0OdFd8L\n zUZBky03X7SOip6odNtqRqS+vPHTG5SuCtitakifBAUf4aNrFZLgrZ38C1sSWCgR\n cvKoq41Ca9tgA5GydXWa0oRwoo34qWfeglJtdTOzos/ZI/nFEr2BRGeBBLYxiQdx\n Gu4G0HGpWzx/gYeuaXeOB9kCgYBEKznPRu+RSORbO60IQ80TYmb8P11WELtw/KIQ\n MjHOkEizLbAt6ksNZ3R/frb6m8JZs1NrTnfN1QlcoNeLg1egTPflDWhLewpj5yTr\n VS+aK5z3ihFYYB45AfD+kfswefFpMzMJeGFVAFLcaIiZk1QstnQUeCvM5BGxPL1S\n Q6xZwQKBgQCSeU8FRIa0jUxN7hx5R1+IAIBPl2JUM7bMME9T3eX3Qh6wNCMjTxse\n NU70sp2m+8sv7Bq4QY5P13Cajo/+fwI1BSa83mF2kXnyEpXsrfw+4FM74YTrX0JA\n FlSDMaL95g7fCSSMuM8sOqMuIBn7d7DiK2nbrez/iRsZFH2qOqusOA==\n
      -----END RSA PRIVATE KEY-----\n
      &AUTHPARAMS
      
    • Response

      <getRootPasswordResponse>
          <requestId>d3709b68-3540-48a7-8fa0-3a40cde57d2c</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <rootPassword>
              <rootPassword>YY64RG6UET2</rootPassword>
          </rootPassword>
      </getRootPasswordResponse>
      

Member server image

getMemberServerImageList

  • API name

    Get member server image list

  • Action

    getMemberServerImageList

  • Description

    Gets a list of member server images.

  • Request parameters

Parameter Brief Description Type Limitations Required
memberServerImageNoList Member server image number list List\ No
platformTypeCodeList.N Platform identification code list List\ Min: 1,
Max: 5
No
regionNo Region number String No
pageNo Page number Integer Min: 0,
Max: 2147483647
No
pageSize Page size Integer No 0,
Max: 2147483647
No
sortedBy Sort by String No
sortingOrder Sort order String No
  • memberServerImageNoList.N
    • List of member server images to view
  • platformTypeCodeList.N
    • List of platform codes of server images to view
    • Linux 32Bit (LNX32) | Linux 64Bit (LNX64) | Windows 32Bit (WND32) | Windows 64Bit (WND64) | Ubuntu Desktop 64Bit (UBD64) | Ubuntu Server 64Bit (UBS64)
  • regionNo
    • Get available values using the getRegionList action.
  • pageNo
    • Page number based on the page size if the number of items is large.
  • pageSize
    • Number of items to be shown per page
  • sortedBy
    • The column based on which you want to sort the list.
    • Member server image name (memberServerImageName) | Member server image number (memberServerImageNo) [case insensitive]
    • Default: Member server image number (memberServerImageNo)
  • sortingOrder

    • Sorting order of the list
    • Ascending (ascending) | Descending (descending) [case insensitive]
    • Default: Ascending (ascending)
  • Example

    • Request

      ${SERVER_API_URL}/getMemberServerImageList
      ?platformTypeCodeList.1=LNX32
      
    • Response

      <getMemberServerImageListResponse>
          <requestId>d5b1eaff-659a-452a-a64b-7dcf5f5e1ddc</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <memberServerImageList>
              <memberServerImage>
                  <memberServerImageNo>1755</memberServerImageNo>
                  <memberServerImageName>img</memberServerImageName>
                  <memberServerImageDescription />
                  <originalServerInstanceNo>67916</originalServerInstanceNo>
                  <originalServerProductCode>SPSVRSTAND000043</originalServerProductCode>
                  <originalServerName>i-0217</originalServerName>
                  <originalBaseBlockStorageDiskType>
                      <code>LOCAL</code>
                      <codeName>Local storage</codeName>
                  </originalBaseBlockStorageDiskType>
                  <originalServerImageProductCode>SPSW0LINUX000009</originalServerImageProductCode>
                  <originalOsInformation>CentOS 5.7 32Bit</originalOsInformation>
                  <originalServerImageName>centos-5.7-32-cnc1</originalServerImageName>
                  <memberServerImageStatusName>created</memberServerImageStatusName>
                  <memberServerImageStatus>
                      <code>CREAT</code>
                      <codeName>NSI CREATED state</codeName>
                  </memberServerImageStatus>
                  <memberServerImageOperation>
                      <code>NULL</code>
                      <codeName>NSI NULLOP</codeName>
                  </memberServerImageOperation>
                  <memberServerImagePlatformTypeCode>
                      <code>LNX32</code>
                      <codeName>Linux 32 Bit</codeName>
                  </memberServerImagePlatformTypeCode>
                  <createDate>2014-02-17T15:20:51+0900</createDate>
                  <region>
                      <regionNo>1</regionNo>
                      <regionCode>KR</regionCode>
                      <regionName>KOREA</regionName>
                  </region>
                  <zone>
                      <zoneNo>2</zoneNo>
                      <zoneName>zone2</zoneName>
                      <zoneDescription>nang zone</zoneDescription>
                  </zone>
                  <memberServerImageBlockStorageTotalRows>2</memberServerImageBlockStorageTotalRows>
                  <memberServerImageBlockStorageTotalSize>13409189888</memberServerImageBlockStorageTotalSize>
              </memberServerImage>
          </memberServerImageList>
      </getMemberServerImageListResponse>
      

createMemberServerImage

  • API name

    Create member server image

  • Action

    createMemberServerImage

  • Description

    Creates member server images.

  • Request parameters

Parameter Brief Description Type Limitations Required
memberServerImageName Member server image name String Min: 3, Max: 30 No
memberServerImageDescription Member server image description String Min: 10,
Max: 1000
No
serverInstanceNo Server instance number String Yes
  • memberServerImageName
    • Name of a member server image to create
    • Default: Automatically specified by Ncloud.
  • memberServerImageDescription
    • Description of a member server image to create.
  • serverInstanceNo

    • Server instance number for which you want to create an image.
    • Required value. Get available values using the getServerInstancelList action.
  • Example

    • Request

      ${SERVER_API_URL}/createMemberServerImage
      ?serverInstanceNo=67953
      
    • Response

      <createMemberServerImageResponse>
          <requestId>303a26e1-85a9-4a0d-ba70-950282144b37</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <memberServerImageList>
              <memberServerImage>
                  <memberServerImageNo>1756</memberServerImageNo>
                  <memberServerImageName>img-7f871658ff847d8</memberServerImageName>
                  <memberServerImageDescription />
                  <originalServerInstanceNo>67953</originalServerInstanceNo>
                  <originalServerProductCode>SPSVRSTAND000043</originalServerProductCode>
                  <originalServerName>myserver</originalServerName>
                  <originalBaseBlockStorageDiskType>
                      <code>LOCAL</code>
                      <codeName>Local storage</codeName>
                  </originalBaseBlockStorageDiskType>
                  <originalServerImageProductCode>SPSW0LINUX000032</originalServerImageProductCode>
                  <originalOsInformation>CentOS 6.3 32Bit</originalOsInformation>
                  <originalServerImageName>centos-6.3-32</originalServerImageName>
                  <memberServerImageStatusName>creating</memberServerImageStatusName>
                  <memberServerImageStatus>
                      <code>INIT</code>
                      <codeName>NSI INIT state</codeName>
                  </memberServerImageStatus>
                  <memberServerImageOperation>
                      <code>CREAT</code>
                      <codeName>NSI CREAT OP</codeName>
                  </memberServerImageOperation>
                  <memberServerImagePlatformTypeCode>
                      <code>LNX32</code>
                      <codeName>Linux 32 Bit</codeName>
                  </memberServerImagePlatformTypeCode>
                  <createDate>2014-02-18T17:22:43+0900</createDate>
                  <memberServerImageBlockStorageTotalRows>0</memberServerImageBlockStorageTotalRows>
                  <memberServerImageBlockStorageTotalSize>0</memberServerImageBlockStorageTotalSize>
              </memberServerImage>
          </memberServerImageList>
      </createMemberServerImageResponse>
      

deleteMemberServerImages

  • API name

    Delete member server images

  • Action

    deleteMemberServerImages

  • Description

    • Deletes member server images.
  • Request parameters
Parameter Brief Description Type Limitations Required
memberServerImageNoList.N Member server image list List\ Duplicates not allowed. Yes
  • Example

  • Request

    ${SERVER_API_URL}/deleteMemberServerImages
    ?memberServerImageNoList.1=1756
    
  • Response

    <deleteMemberServerImagesResponse>
        <requestId>b5bc0716-32e5-4edf-bf39-9eabfb2efdaf</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <memberServerImageList>
            <memberServerImage>
                <memberServerImageNo>1756</memberServerImageNo>
                <memberServerImageName>img-7f871658ff847d8</memberServerImageName>
                <memberServerImageDescription />
                <originalServerInstanceNo>67953</originalServerInstanceNo>
                <originalServerProductCode>SPSVRSTAND000043</originalServerProductCode>
                <originalServerName>myserver</originalServerName>
                <originalBaseBlockStorageDiskType>
                    <code>LOCAL</code>
                    <codeName>Local storage</codeName>
                </originalBaseBlockStorageDiskType>
                <originalServerImageProductCode>SPSW0LINUX000032</originalServerImageProductCode>
                <originalOsInformation>CentOS 6.3 32Bit</originalOsInformation>
                <originalServerImageName>centos-6.3-32</originalServerImageName>
                <memberServerImageStatusName>terminating</memberServerImageStatusName>
                <memberServerImageStatus>
                    <code>CREAT</code>
                    <codeName>NSI CREATED state</codeName>
                </memberServerImageStatus>
                <memberServerImageOperation>
                    <code>TERMT</code>
                    <codeName>NSI TERMINATE OP</codeName>
                </memberServerImageOperation>
                <memberServerImagePlatformTypeCode>
                    <code>LNX32</code>
                    <codeName>Linux 32 Bit</codeName>
                </memberServerImagePlatformTypeCode>
                <createDate>2014-02-18T17:22:43+0900</createDate>
                <region>
                    <regionNo>1</regionNo>
                    <regionCode>KR</regionCode>
                    <regionName>KOREA</regionName>
                </region>
                <zone>
                    <zoneNo>3</zoneNo>
                    <zoneName>zone3</zoneName>
                    <zoneDescription>nang zone2</zoneDescription>
                </zone>
                <memberServerImageBlockStorageTotalRows>2</memberServerImageBlockStorageTotalRows>
                <memberServerImageBlockStorageTotalSize>13409189888</memberServerImageBlockStorageTotalSize>
            </memberServerImage>
        </memberServerImageList>
    </deleteMemberServerImagesResponse>
    

Block storage

getBlockStorageInstanceList

  • API name

    Get block storage instance list

  • Action

    getBlockStorageInstanceList

  • Description

    Gets a list of block storage instances.

  • Request parameters
Parameter Brief Description Type Limitations Required
serverInstanceNo Server instance number String No
blockStorageInstanceNoList Block storage instance number list List\ No
searchFilterName Filter name to search String No
searchFilterValue Filter value to search String No
blockStorageTypeCodeList.N Block storage type code list List\ Min: 1,
Max: 5
No
blockStorageInstanceStatusCode Block storage instance status code String Min: 1,
Max: 5
No
diskTypeCode Disk type code String No
diskDetailTypeCode Detailed disk type code String No
regionNo Region number String No
zoneNo Zone number String No
pageNo Page number Integer Min: 0,
Max: 2147483647
No
pageSize Page size Integer Min: 0,
Max: 2147483647
No
sortedBy Sort by String No
sortingOrder Sort order String No
  • serverInstanceNo
    • It is used to get the block storage attached to a specific server instance.
  • blockStorageInstanceNoList.N
    • Gets the block storage instances corresponding to the block storage instance number list.
  • searchFilterName
    • Block storage name (blockStorageName) | Attachment information (attachmentInformation) [case insensitive] Attachment information should be entered as “block storage name[space]attachment information” or “block storage name:attachment information.”
  • searchFilterValue
    • Filter value to search
  • blockStorageTypeCodeList.N You can view only the block storage instances corresponding to the block storage type code list.
    • Basic block storage (BASIC) | Additional block storage (SVRBS)
    • Default: Basic block storage (BASIC), Additional block storage (SVRBS)
  • blockStorageInstanceStatusCode
    • The result can be viewed by block storage instance status.
    • Please refer to the block storage instance status (blockStorageInstanceStatus) value of block storage instance data type (BlockStorageInstance) for available status.
  • diskTypeCode
    • Disk type code
    • Network storage (NET) | Local storage (LOCAL)
  • diskDetailTypeCode
    • Detailed disk type code
    • Hard disk (HDD) | SSD (SSD)
  • regionNo
    • Get available values using the getRegionList action.
  • zoneNo
    • You can filter the list of block storage instances by zones.
    • All the zones in the region will be selected if the filter is not specified.
  • pageNo
    • Page number based on the page size if the number of items is large.
  • pageSize
    • Number of items to be shown per page
  • sortedBy
    • The column based on which you want to sort the list.
    • Block storage name (blockStorageName) | Block storage instance number (blockStorageInstanceNo)[case insensitive]
    • Default: Block storage instance number (blockStorageInstanceNo)
  • sortingOrder

    • Sorting order of the list
    • Ascending (ascending) | Descending (descending) [case insensitive]
    • Default: Ascending (ascending)
  • Example

    • Request

      ${SERVER_API_URL}/getBlockStorageInstanceList
      ?blockStorageInstanceStatusCode=ATTAC
      &blockStorageTypeCodeList.1=BASIC
      
    • Response

      <getBlockStorageInstanceListResponse>
         <requestId>78128ff9-dab5-432f-af63-ae29247c14f6</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>40</totalRows>
         <blockStorageInstanceList>
            <blockStorageInstance>
               <blockStorageInstanceNo>320132</blockStorageInstanceNo>
               <serverInstanceNo>320131</serverInstanceNo>
               <serverName>svr-9ad2547efcc382a</serverName>
               <blockStorageType>
                  <code>BASIC</code>
                  <codeName>Basic BS</codeName>
               </blockStorageType>
               <blockStorageName>svr-9ad2547efcc382a</blockStorageName>
               <blockStorageSize>53687091200</blockStorageSize>
               <deviceName />
               <blockStorageProductCode>SPBSTBSTBS000001</blockStorageProductCode>
               <blockStorageInstanceStatus>
                  <code>INIT</code>
                  <codeName>Block storage INIT state</codeName>
               </blockStorageInstanceStatus>
               <blockStorageInstanceOperation>
                  <code>CREAT</code>
                  <codeName>Block storage CREATE OP</codeName>
               </blockStorageInstanceOperation>
               <blockStorageInstanceStatusName>creating</blockStorageInstanceStatusName>
               <createDate>2017-02-28T15:14:25+0900</createDate>
               <blockStorageInstanceDescription>svr-9ad2547efcc382a's basic storage</blockStorageInstanceDescription>
               <diskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </diskType>
               <diskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </diskDetailType>
            </blockStorageInstance>
         </blockStorageInstanceList>
      </getBlockStorageInstanceListResponse>
      

createBlockStorageInstance

  • API name

    Create block storage instance

  • Action

    createBlockStorageInstance

  • Description

    Creates a block storage instance.

  • Request parameters
Parameter Brief Description Type Limitations Required
blockStorageName Block storage name String Min: 3, Max: 30 No
blockStorageSize Block storage size Long Min: 10, Max: 1000 Yes
blockStorageDescription Block storage description String Min: 10, Max: 1000 No
serverInstanceNo Server instance number String Yes
diskDetailTypeCode Disk detail type code(HDD/SDD) String Min : 1, Max : 5 No
  • blockStorageName
    • Name of block storage to create.
    • Default: Automatically specified by Ncloud.
  • blockStorageSize
    • Size of block storage to create. The unit is GB, and you can enter up to 1000 GB.
  • blockStorageDescription
    • Description of block storage
  • serverInstanceNo
    • Server instance number to attach
    • Required value. Get available values using the getServerInstancelList action.
  • diskDetailTypeCode

    • You can choose a disk detail type code of HDD and SSD.
    • default : HDD
  • Example

    • Request

      ${SERVER_API_URL}/createBlockStorageInstance
      ?blockStorageSize=10
      &serverInstanceNo=67953
      
    • Response

      <createBlockStorageInstanceResponse>
         <requestId>45d8b5bb-a2d7-4404-87a3-d04ad9efb4aa</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <blockStorageInstanceList>
            <blockStorageInstance>
               <blockStorageInstanceNo>340846</blockStorageInstanceNo>
               <serverInstanceNo>340837</serverInstanceNo>
               <serverName>jin-good12</serverName>
               <blockStorageType>
                  <code>SVRBS</code>
                  <codeName>Server BS</codeName>
               </blockStorageType>
               <blockStorageName>bst-9b467cb6510c782</blockStorageName>
               <blockStorageSize>10737418240</blockStorageSize>
               <deviceName />
               <blockStorageProductCode>SPBSTBSTAD000002</blockStorageProductCode>
               <blockStorageInstanceStatus>
                  <code>INIT</code>
                  <codeName>Block storage INIT state</codeName>
               </blockStorageInstanceStatus>
               <blockStorageInstanceOperation>
                  <code>NULL</code>
                  <codeName>Block Storage NULLOP</codeName>
               </blockStorageInstanceOperation>
               <blockStorageInstanceStatusName>initialized</blockStorageInstanceStatusName>
               <createDate>2017-07-27T04:23:39+0900</createDate>
               <blockStorageInstanceDescription />
               <diskType>
                  <code>NET</code>
                  <codeName>Network Storage</codeName>
               </diskType>
               <diskDetailType>
                  <code>HDD</code>
                  <codeName>HDD</codeName>
               </diskDetailType>
            </blockStorageInstance>
         </blockStorageInstanceList>
      </createBlockStorageInstanceResponse>
      

deleteBlockStorageInstances

  • API name

    Delete block storage instances

  • Action

    deleteBlockStorageInstances

  • Description

    Deletes block storage instances, which must be detached first.

  • Request parameters
Parameter Brief Description Type Limitations Required
blockStorageInstanceNoList Block storage instance number list List\ Duplicates not allowed. Yes
  • blockStorageInstanceNoList.N

    • List of block storage instance numbers to delete
    • Get available values using the getBlockStorageInstanceList action.
  • Example

    • Request
    ${SERVER_API_URL}/deleteBlockStorageInstances
    ?blockStorageInstanceNoList.1=340846
    
    • Response
    <deleteBlockStorageInstancesResponse>
       <requestId>f7ccf579-d8ec-4e9e-930a-567e38cb286c</requestId>
       <returnCode>0</returnCode>
       <returnMessage>success</returnMessage>
       <totalRows>1</totalRows>
       <blockStorageInstanceList>
          <blockStorageInstance>
             <blockStorageInstanceNo>340846</blockStorageInstanceNo>
             <serverInstanceNo>340837</serverInstanceNo>
             <serverName>jin-good12</serverName>
             <blockStorageType>
                <code>SVRBS</code>
                <codeName>Server BS</codeName>
             </blockStorageType>
             <blockStorageName>bst-9b467cb6510c782</blockStorageName>
             <blockStorageSize>10737418240</blockStorageSize>
             <deviceName>/dev/xvdb</deviceName>
             <blockStorageProductCode>SPBSTBSTAD000002</blockStorageProductCode>
             <blockStorageInstanceStatus>
                <code>ATTAC</code>
                <codeName>Block storage ATTACHED state</codeName>
             </blockStorageInstanceStatus>
             <blockStorageInstanceOperation>
                <code>DETAC</code>
                <codeName>Block Storage RESTART OP</codeName>
             </blockStorageInstanceOperation>
             <blockStorageInstanceStatusName>detaching</blockStorageInstanceStatusName>
             <createDate>2017-07-27T04:23:39+0900</createDate>
             <blockStorageInstanceDescription />
             <diskType>
                <code>NET</code>
                <codeName>Network Storage</codeName>
             </diskType>
             <diskDetailType>
                <code>HDD</code>
                <codeName>HDD</codeName>
             </diskDetailType>
          </blockStorageInstance>
       </blockStorageInstanceList>
    </deleteBlockStorageInstancesResponse>
    

createBlockStorageSnapshotInstance

  • API Name

    Creating a block storage snapshot instance

  • action

    createBlockStorageSnapshotInstance

  • Description

    Create a block storage snapshot instance.

  • Request parameters
Parameter Name Brief Description Type Limitation Requiredness
blockStorageInstanceNo Block storage instance No. String Repeat not allowed Yes
blockStorageSnapshotName Block storage snapshot name String Min : 3, Max : 30 No
blockStorageSnapshotDescription Block storage snapshot description String Min : 10, Max : 1000 No
  • blockStorageInstanceNo
    • Block storage instance No for creating snapshot
  • blockStorageSnapshotName
    • Block storage snapshot name to create
    • default : Ncloud assigns default values.
  • blockStorageSnapshotDescription

    • Descriptions on a snapshot to create
  • Example

    • Request

      ${SERVER_API_URL}/createBlockStorageSnapshotInstance
      
    • Response

      <createBlockStorageSnapshotInstanceResponse>
         <script />
         <requestId>8ee82b50-bb6c-428e-bd1a-55af5864a1b2</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <blockStorageSnapshotInstanceList>
            <blockStorageSnapshot>
           <blockStorageSnapshotInstanceNo>694783</blockStorageSnapshotInstanceNo>
           <blockStorageSnapshotName>snap1644516a9a5</blockStorageSnapshotName>
           <blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
           <originalBlockStorageInstanceNo>694553</originalBlockStorageInstanceNo>
           <originalBlockStorageName>s-5ds0yzequgdxx</originalBlockStorageName>
           <blockStorageSnapshotInstanceStatus>
              <code>INIT</code>
              <codeName>Block storage INIT state</codeName>
           </blockStorageSnapshotInstanceStatus>
           <blockStorageSnapshotInstanceOperation>
              <code>NULL</code>
              <codeName>Block Storage NULLOP</codeName>
           </blockStorageSnapshotInstanceOperation>
           <blockStorageSnapshotInstanceStatusName>initialized</blockStorageSnapshotInstanceStatusName>
           <createDate>2018-06-28T15:31:10+0900</createDate>
           <blockStorageSnapshotInstanceDescription />
           <serverImageProductCode>SPSW0LINUX000046</serverImageProductCode>
           <osInformation>CentOS 7.3 (64-bit)</osInformation>
            </blockStorageSnapshot>
         </blockStorageSnapshotInstanceList>
      </createBlockStorageSnapshotInstanceResponse>
      

deleteBlockStorageSnapshotInstances

  • API Name

    Deleting a block storage snapshot instance

  • action

    deleteBlockStorageSnapshotInstances

  • Description

    Delete a block storage snapshot instance.

  • Request parameters
Parameter Name Brief Description Type Limitation Requiredness
blockStorageSnapshotInstanceNoList.N Block storage snapshot instance No. list List\ Repeat not allowed Yes
  • blockStorageSnapshotInstanceNoList

    • Block storage instance No for creating snapshot
  • Example

    • Request

      ${SERVER_API_URL}/deleteBlockStorageSnapshotInstances
      
    • Response

      <deleteBlockStorageSnapshotInstancesResponse>
         <script />
         <requestId>15104c45-243f-4e98-8841-4cff02e08bb6</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>1</totalRows>
         <blockStorageSnapshotInstanceList>
            <blockStorageSnapshot>
           <blockStorageSnapshotInstanceNo>693535</blockStorageSnapshotInstanceNo>
           <blockStorageSnapshotName>snap164355fe5f4</blockStorageSnapshotName>
           <blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
           <originalBlockStorageInstanceNo>691658</originalBlockStorageInstanceNo>
           <originalBlockStorageName>ms-ad-test-01</originalBlockStorageName>
           <blockStorageSnapshotInstanceStatus>
              <code>CREAT</code>
              <codeName>Block storage CREATED state</codeName>
           </blockStorageSnapshotInstanceStatus>
           <blockStorageSnapshotInstanceOperation>
              <code>TERMT</code>
              <codeName>Block Storage TERMINATE OP</codeName>
           </blockStorageSnapshotInstanceOperation>
           <blockStorageSnapshotInstanceStatusName>terminating</blockStorageSnapshotInstanceStatusName>
           <createDate>2018-06-25T14:17:14+0900</createDate>
           <blockStorageSnapshotInstanceDescription />
           <serverImageProductCode>SPSW0WINNTEN0016</serverImageProductCode>
           <osInformation>Windows Server 2016 (64-bit) English Edition</osInformation>
            </blockStorageSnapshot>
         </blockStorageSnapshotInstanceList>
      </deleteBlockStorageSnapshotInstancesResponse>
      

      getBlockStorageSnapshotInstanceList

  • API name

    Get block storage snapshot instance list

  • Action

    getBlockStorageSnapshotInstanceList

  • Description

    Gets a list of block storage snapshot instances.

  • Request parameters
Parameter Name Brief Description Type Limitation Requiredness
blockStorageSnapshotInstanceNoList Block storage snapshot instance No. list List\ No
originalBlockStorageInstanceNoList Block storage instance No. list List\ No
regionNo Region No. String No
pageNo Page No. Integer Min : 0, Max : 2147483647 No
pageSize Page size Integer Min : 0, Max : 2147483647 No
  • blockStorageSnapshotInstanceNoList
    • Search a block storage snapshot matching to the block storage snapshot instance No. list.
  • originalBlockStorageInstanceNoList
    • Search a block storage snapshot matching to the original block storage instance No. list.
  • regionNo
    • Get available values using the getRegionList action.
  • pageNo
    • Page number based on the page size if the number of items is large.
  • pageSize

    • Number of items to be shown per page
  • Example

    • Request

      ${SERVER_API_URL}/getBlockStorageSnapshotInstanceList
      
    • Response

      <getBlockStorageSnapshotInstanceListResponse>
         <requestId>78ca2d57-d729-4077-b0ff-ce35248b71de</requestId>
         <returnCode>0</returnCode>
         <returnMessage>success</returnMessage>
         <totalRows>3</totalRows>
         <blockStorageSnapshotInstanceList>
            <blockStorageSnapshot>
               <blockStorageSnapshotInstanceNo>334118</blockStorageSnapshotInstanceNo>
               <blockStorageSnapshotName>s0615bc</blockStorageSnapshotName>
               <blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
               <originalBlockStorageInstanceNo>334105</originalBlockStorageInstanceNo>
               <originalBlockStorageName>x0627</originalBlockStorageName>
               <blockStorageSnapshotInstanceStatus>
                  <code>CREAT</code>
                  <codeName>Block storage CREATED state</codeName>
               </blockStorageSnapshotInstanceStatus>
               <blockStorageSnapshotInstanceOperation>
                  <code>NULL</code>
                  <codeName>Block Storage NULLOP</codeName>
               </blockStorageSnapshotInstanceOperation>
               <createDate>2017-06-27T18:56:42+0900</createDate>
               <blockStorageSnapshotInstanceDescription />
               <serverImageProductCode>SPSW0WINNT000016</serverImageProductCode>
               <osInformation>Windows Server 2016 (64-bit)</osInformation>
            </blockStorageSnapshot>
         </blockStorageSnapshotInstanceList>
      </getBlockStorageSnapshotInstanceListResponse>
      

Public IP

getPublicIpInstanceList

  • API name

    Get public IP instance list

  • Action

    getPublicIpInstanceList

  • Description

    Gets a list of public IP instances. The results can be paginated.

  • Request parameters

Parameter Brief Description Type Limitations Required
isAssociated Indicates whether it is associated or not. Boolean No
publicIpInstanceNoList.N Public IP instance number list String Duplicates not allowed. No
publicIpList.N Public IP list String Min: 5, Max: 15 No
searchFilterName Filter name to search String No
searchFilterValue Filter value to search String No
internetLineTypeCode Internet line type code String Min: 1, Max: 5 No
regionNo Region number String No
zoneNo Zone number String No
pageNo Page number Integer Min: 0,
Max: 2147483647
No
pageSize Page size Integer Min: 0,
Max: 2147483647
No
sortedBy Sort by String No
sortingOrder Sort order String No
  • isAssociated
    • Indicates whether the public IP address is associated or not.
  • publicIpInstanceNoList.N
    • List of public IP instance numbers to get.
  • publicIpList.N
    • List of public IP addresses to get.
  • searchFilterName
    • Public IP (publicIp) | Associated server name (associatedServerName)
  • searchFilterValue
    • Filter value to search
  • internetLineTypeCode
    • Internet line type code
    • PUBLC (Public), GLBL (Global)
  • regionNo
    • Get available values using the getRegionList action.
  • pageNo
    • Page number based on the page size if the number of items is large.
  • zoneNo
    • You can filter the list of public IP instances by zones.
    • All the public IP addresses in the zone of the region will be selected if the filter is not specified.
  • pageSize
    • Number of items to be shown per page
  • sortedBy
    • The column based on which you want to sort the list.
    • Public IP (publicIp) | Public IP instance number (publicIpInstanceNo) [case insensitive]
    • Default: Public IP instance number (publicIpInstanceNo)
  • sortingOrder

    • Sorting order of the list
    • Ascending (ascending) | Descending (descending) [case insensitive]
    • Default: Ascending (ascending)
  • Example

    • Request

      ${SERVER_API_URL}/getPublicIpInstanceList
      
    • Response

      <getPublicIpInstanceListResponse>
          <requestId>98275c8a-0865-4c8f-8273-80878b42704c</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>2</totalRows>
          <publicIpInstanceList>
              <publicIpInstance>
                  <publicIpInstanceNo>67653</publicIpInstanceNo>
                  <publicIp>192.168.200.156</publicIp>
                  <publicIpDescription>Default public IP</publicIpDescription>
                  <createDate>2014-02-06T15:21:41+0900</createDate>
                  <internetLineType>
                      <code>PUBLC</code>
                      <codeName>Public</codeName>
                  </internetLineType>
                  <publicIpInstanceStatusName>used</publicIpInstanceStatusName>
                  <publicIpInstanceStatus>
                      <code>USED</code>
                      <codeName>NET USED state</codeName>
                  </publicIpInstanceStatus>
                  <publicIpInstanceOperation>
                      <code>NULL</code>
                      <codeName>NET NULL OP</codeName>
                  </publicIpInstanceOperation>
                  <publicIpKindType>
                      <code>DFLT</code>
                      <codeName>Default</codeName>
                  </publicIpKindType>
                  <serverInstanceAssociatedWithPublicIp>
                      <serverInstanceNo>67920</serverInstanceNo>
                      <serverName>svr-7f86d7cf2279599</serverName>
                      <serverDescription>Automatically created server that belongs to the auto scaling group, "asg-0212."</serverDescription>
                      <cpuCount>2</cpuCount>
                      <memorySize>4294967296</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>LNX32</code>
                          <codeName>Linux 32 Bit</codeName>
                      </platformType>
                      <loginKeyName>yh-nang-test</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp>192.168.200.156</publicIp>
                      <privateIp>10.101.6.75</privateIp>
                      <serverImageName>centos-5.7-32-cnc1</serverImageName>
                      <serverInstanceStatus>
                          <code>RUN</code>
                          <codeName>Server run state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>running</serverInstanceStatusName>
                      <createDate>2014-02-17T12:30:21+0900</createDate>
                      <uptime>2014-02-17T13:55:03+0900</uptime>
                      <serverImageProductCode>SPSW0LINUX000009</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000043</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp />
                      <zone>
                          <zoneNo>2</zoneNo>
                          <zoneName>zone2</zoneName>
                          <zoneDescription>nang zone</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>LOCAL</code>
                          <codeName>Local storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                              <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                              <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                              <isDefault>true</isDefault>
                              <createDate>2013-12-03T10:37:39+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstanceAssociatedWithPublicIp>
              </publicIpInstance>
              <publicIpInstance>
                  <publicIpInstanceNo>68002</publicIpInstanceNo>
                  <publicIp>192.168.200.195</publicIp>
                  <publicIpDescription />
                  <createDate>2014-02-18T17:42:23+0900</createDate>
                  <publicIpInstanceStatusName>created</publicIpInstanceStatusName>
                  <publicIpInstanceStatus>
                      <code>CREAT</code>
                      <codeName>NET CREATE state</codeName>
                  </publicIpInstanceStatus>
                  <publicIpInstanceOperation>
                      <code>NULL</code>
                      <codeName>NET NULL OP</codeName>
                  </publicIpInstanceOperation>
                  <publicIpKindType>
                      <code>GEN</code>
                      <codeName>General</codeName>
                  </publicIpKindType>
                  <serverInstanceAssociatedWithPublicIp />
              </publicIpInstance>
          </publicIpInstanceList>
      </getPublicIpInstanceListResponse>
      

getPublicIpTargetServerInstanceList

  • API name

    Get public IP target server instance list

  • Action

    getPublicIpTargetServerInstanceList

  • Description

    Gets a list of server instances which public IP addresses are (can be) associated with.

  • Request parameters

Parameter Brief Description Type Limitations Required
internetLineTypeCode Internet line type code String Min: 1, Max: 5 No
regionNo Region number String No
zoneNo Zone number String No
  • internetLineTypeCode
    • Internet line type code
    • PUBLC (Public), GLBL (Global)
  • regionNo

    • Get available values using the getRegionList action.
  • Example

    • Request

      ${SERVER_API_URL}/getPublicIpTargetServerInstanceList
      ?serverInstanceNo=67953
      
    • Response

      <getPublicIpTargetServerInstanceListResponse>
          <requestId>fc0a990d-1536-4285-a6cb-d2a4cc203b52</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>3</totalRows>
          <serverInstanceList>
              <serverInstance>
                  <serverInstanceNo>67943</serverInstanceNo>
                  <serverName>svr-7f86d867d343949</serverName>
                  <serverDescription>Automatically created server that belongs to the auto scaling group, "asg-0212."</serverDescription>
                  <cpuCount>2</cpuCount>
                  <memorySize>4294967296</memorySize>
                  <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                  <platformType>
                      <code>LNX32</code>
                      <codeName>Linux 32 Bit</codeName>
                  </platformType>
                  <loginKeyName>yh-nang-test</loginKeyName>
                  <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                  <publicIp />
                  <privateIp>10.101.5.109</privateIp>
                  <serverImageName>centos-5.7-32-cnc1</serverImageName>
                  <serverInstanceStatus>
                      <code>RUN</code>
                      <codeName>Server run state</codeName>
                  </serverInstanceStatus>
                  <serverInstanceOperation>
                      <code>NULL</code>
                      <codeName>Server NULL OP</codeName>
                  </serverInstanceOperation>
                  <serverInstanceStatusName>running</serverInstanceStatusName>
                  <createDate>2014-02-17T13:30:28+0900</createDate>
                  <uptime>2014-02-17T13:37:30+0900</uptime>
                  <serverImageProductCode>SPSW0LINUX000009</serverImageProductCode>
                  <serverProductCode>SPSVRSTAND000043</serverProductCode>
                  <isProtectServerTermination>false</isProtectServerTermination>
                  <portForwardingPublicIp />
                  <zone>
                      <zoneNo>3</zoneNo>
                      <zoneName>zone3</zoneName>
                      <zoneDescription>nang zone2</zoneDescription>
                  </zone>
                  <region>
                      <regionNo>1</regionNo>
                      <regionCode>KR</regionCode>
                      <regionName>KOREA</regionName>
                  </region>
                  <baseBlockStorageDiskType>
                      <code>LOCAL</code>
                      <codeName>Local storage</codeName>
                  </baseBlockStorageDiskType>
                  <internetLineType>
                      <code>PUBLC</code>
                      <codeName>Public</codeName>
                  </internetLineType>
                  <userData />
                  <accessControlGroupList>
                      <accessControlGroup>
                          <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                          <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                          <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                          <isDefault>true</isDefault>
                          <createDate>2013-12-03T10:37:39+0900</createDate>
                      </accessControlGroup>
                  </accessControlGroupList>
              </serverInstance></serverInstanceList>
      </getPublicIpTargetServerInstanceListResponse>
      

createPublicIpInstance

  • API name

    Create public IP instance

  • Action

    createPublicIpInstance

  • Description

    Creates public IP instances.

  • Request parameters

Parameter Brief Description Type Limitations Required
serverInstanceNo Server instance number String No
publicIpDescription Public IP description String Min: 10, Max: 1000 No
internetLineTypeCode Internet line type code String Min: 1, Max: 5 No
regionNo Region number String No
zoneNo Zone number String No
  • serverInstanceNo
    • Server instance number which you want to create a public IP address and associate it with.
    • Get available values using the getPublicIpTargetServerInstanceList action.
  • publicIpDescription
    • Description of a public IP address to create
  • internetLineTypeCode
    • Internet line type code
    • PUBLC (Public), GLBL (Global)
    • Default: PUBLC (Public)
  • regionNo
    • Get available values using the getRegionList action.
  • zoneNo

    • Zone in which you want to create a public IP address.
    • Get available values using the getZoneList action.
    • Default: The first zone of the region.
  • Example

    • Request

      ${SERVER_API_URL}/createPublicIpInstance
      ?serverInstanceNo=67953
      
    • Response

      <createPublicIpInstanceResponse>
          <requestId>f1a120a8-c5b3-4b2f-b672-9f4b40f4d8a4</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <publicIpInstanceList>
              <publicIpInstance>
                  <publicIpInstanceNo>68003</publicIpInstanceNo>
                  <publicIp>192.168.200.198</publicIp>
                  <publicIpDescription />
                  <createDate>2014-02-18T17:50:05+0900</createDate>
                  <internetLineType>
                      <code>PUBLC</code>
                      <codeName>Public</codeName>
                  </internetLineType>
                  <publicIpInstanceStatusName>using</publicIpInstanceStatusName>
                  <publicIpInstanceStatus>
                      <code>CREAT</code>
                      <codeName>NET CREATE state</codeName>
                  </publicIpInstanceStatus>
                  <publicIpInstanceOperation>
                      <code>USE</code>
                      <codeName>NET USE OP</codeName>
                  </publicIpInstanceOperation>
                  <publicIpKindType>
                      <code>GEN</code>
                      <codeName>General</codeName>
                  </publicIpKindType>
                  <serverInstanceAssociatedWithPublicIp>
                      <serverInstanceNo>67953</serverInstanceNo>
                      <serverName>myserver</serverName>
                      <serverDescription />
                      <cpuCount>2</cpuCount>
                      <memorySize>4294967296</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>LNX32</code>
                          <codeName>Linux 32 Bit</codeName>
                      </platformType>
                      <loginKeyName>hkey-0217</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp>192.168.200.198</publicIp>
                      <privateIp>10.101.5.105</privateIp>
                      <serverImageName>centos-6.3-32</serverImageName>
                      <serverInstanceStatus>
                          <code>NSTOP</code>
                          <codeName>Server normal stopped state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>stopped</serverInstanceStatusName>
                      <createDate>2014-02-17T18:04:49+0900</createDate>
                      <uptime>2014-02-18T14:58:26+0900</uptime>
                      <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000043</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp />
                      <zone>
                          <zoneNo>3</zoneNo>
                          <zoneName>zone3</zoneName>
                          <zoneDescription>nang zone2</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>LOCAL</code>
                          <codeName>Local storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                              <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                              <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                              <isDefault>true</isDefault>
                              <createDate>2013-12-03T10:37:39+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstanceAssociatedWithPublicIp>
              </publicIpInstance>
          </publicIpInstanceList>
      </createPublicIpInstanceResponse>
      

associatePublicIpWithServerInstance

  • API name

    Associate server instance to public IP

  • Action

    associatePublicIpWithServerInstance

  • Description

    • Associates a public IP address with a server instance.
  • Request parameters

Parameter Brief Description Type Limitations Required
publicIpInstanceNo Public IP instance number String Yes
serverInstanceNo Server instance number String Yes
  • publicIpInstanceNo
    • Public IP instance number to associate.
  • serverInstanceNo

    • List of server instance numbers you want to associate the public IP address with.
    • Get available values using the getPublicIpTargetServerInstanceList action.
  • Example

    • Request

      ${SERVER_API_URL}/associatePublicIpWithServerInstance
      ?publicIpInstanceNo=68002
      &serverInstanceNo=67953
      
    • Response

      <associatePublicIpWithServerInstanceResponse>
          <requestId>9b87c1c5-416f-442f-8f11-74e34ba75999</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <publicIpInstanceList>
              <publicIpInstance>
                  <publicIpInstanceNo>68002</publicIpInstanceNo>
                  <publicIp>192.168.200.195</publicIp>
                  <publicIpDescription />
                  <createDate>2014-02-18T17:42:23+0900</createDate>
                  <internetLineType>
                      <code>PUBLC</code>
                      <codeName>Public</codeName>
                  </internetLineType>
                  <publicIpInstanceStatusName>using</publicIpInstanceStatusName>
                  <publicIpInstanceStatus>
                      <code>CREAT</code>
                      <codeName>NET CREATE state</codeName>
                  </publicIpInstanceStatus>
                  <publicIpInstanceOperation>
                      <code>USE</code>
                      <codeName>NET USE OP</codeName>
                  </publicIpInstanceOperation>
                  <publicIpKindType>
                      <code>GEN</code>
                      <codeName>General</codeName>
                  </publicIpKindType>
                  <serverInstanceAssociatedWithPublicIp>
                      <serverInstanceNo>67953</serverInstanceNo>
                      <serverName>myserver</serverName>
                      <serverDescription />
                      <cpuCount>2</cpuCount>
                      <memorySize>4294967296</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>LNX32</code>
                          <codeName>Linux 32 Bit</codeName>
                      </platformType>
                      <loginKeyName>hkey-0217</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp>192.168.200.195</publicIp>
                      <privateIp>10.101.5.105</privateIp>
                      <serverImageName>centos-6.3-32</serverImageName>
                      <serverInstanceStatus>
                          <code>NSTOP</code>
                          <codeName>Server normal stopped state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>stopped</serverInstanceStatusName>
                      <createDate>2014-02-17T18:04:49+0900</createDate>
                      <uptime>2014-02-18T14:58:26+0900</uptime>
                      <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000043</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp />
                      <zone>
                          <zoneNo>3</zoneNo>
                          <zoneName>zone3</zoneName>
                          <zoneDescription>nang zone2</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>LOCAL</code>
                          <codeName>Local storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                              <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                              <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                              <isDefault>true</isDefault>
                              <createDate>2013-12-03T10:37:39+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstanceAssociatedWithPublicIp>
              </publicIpInstance>
          </publicIpInstanceList>
      </associatePublicIpWithServerInstanceResponse>
      

disassociatePublicIpFromServerInstance

  • API name

    Disassociate public IP from server instance

  • Action

    disassociatePublicIpFromServerInstance

  • Description

    • Disassociates a public IP address from a server instance.
  • Request parameters
Parameter Brief Description Type Limitations Required
publicIpInstanceNo Public IP instance number String Yes
  • publicIpInstanceNo

    • Public IP instance number to disassociate.
  • Example

    • Request

      ${SERVER_API_URL}/disassociatePublicIpFromServerInstance
      ?publicIpInstanceNo=68002
      
    • Response

      <disassociatePublicIpFromServerInstanceResponse>
          <requestId>cc6072ce-4ac4-4606-abd4-7b0e226918a7</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <publicIpInstanceList>
              <publicIpInstance>
                  <publicIpInstanceNo>68002</publicIpInstanceNo>
                  <publicIp>192.168.200.195</publicIp>
                  <publicIpDescription />
                  <createDate>2014-02-18T17:42:23+0900</createDate>
                  <internetLineType>
                      <code>PUBLC</code>
                      <codeName>Public</codeName>
                  </internetLineType>
                  <publicIpInstanceStatusName>disusing</publicIpInstanceStatusName>
                  <publicIpInstanceStatus>
                      <code>USED</code>
                      <codeName>NET USED state</codeName>
                  </publicIpInstanceStatus>
                  <publicIpInstanceOperation>
                      <code>DISUS</code>
                      <codeName>NET DISUSE OP</codeName>
                  </publicIpInstanceOperation>
                  <publicIpKindType>
                      <code>GEN</code>
                      <codeName>General</codeName>
                  </publicIpKindType>
                  <serverInstanceAssociatedWithPublicIp>
                      <serverInstanceNo>67953</serverInstanceNo>
                      <serverName>myserver</serverName>
                      <serverDescription />
                      <cpuCount>2</cpuCount>
                      <memorySize>4294967296</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>LNX32</code>
                          <codeName>Linux 32 Bit</codeName>
                      </platformType>
                      <loginKeyName>hkey-0217</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp>192.168.200.195</publicIp>
                      <privateIp>10.101.5.105</privateIp>
                      <serverImageName>centos-6.3-32</serverImageName>
                      <serverInstanceStatus>
                          <code>NSTOP</code>
                          <codeName>Server normal stopped state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>stopped</serverInstanceStatusName>
                      <createDate>2014-02-17T18:04:49+0900</createDate>
                      <uptime>2014-02-18T14:58:26+0900</uptime>
                      <serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000043</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp />
                      <zone>
                          <zoneNo>3</zoneNo>
                          <zoneName>zone3</zoneName>
                          <zoneDescription>nang zone2</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>LOCAL</code>
                          <codeName>Local storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                              <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                              <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                              <isDefault>true</isDefault>
                              <createDate>2013-12-03T10:37:39+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstanceAssociatedWithPublicIp>
              </publicIpInstance>
          </publicIpInstanceList>
      </disassociatePublicIpFromServerInstanceResponse>
      

deletePublicIpInstances

  • API name

    Delete public IP instances

  • Action

    deletePublicIpInstances

  • Description Deletes public IP instances.

  • Request parameters
Parameter Brief Description Type Limitations Required
publicIpInstanceNoList.N Public IP instance number list List\ Duplicates not allowed. Yes
  • publicIpInstanceNoList.N

    • List of public IP instance numbers to delete.
    • Get available values using the getPublicIpInstanceList action.
  • Example

    • Request

      ${SERVER_API_URL}/deletePublicIpInstances
      ?publicIpInstanceNoList.1=68002
      
    • Response

      <deletePublicIpInstancesResponse>
          <requestId>72c30b26-1c10-4c1b-a6d2-4669e1899e9c</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <publicIpInstanceList>
              <publicIpInstance>
                  <publicIpInstanceNo>68002</publicIpInstanceNo>
                  <publicIp>192.168.200.195</publicIp>
                  <publicIpDescription />
                  <createDate>2014-02-18T17:42:23+0900</createDate>
                  <internetLineType>
                      <code>PUBLC</code>
                      <codeName>Public</codeName>
                  </internetLineType>
                  <publicIpInstanceStatusName>terminated</publicIpInstanceStatusName>
                  <publicIpInstanceStatus>
                      <code>TERMT</code>
                      <codeName>NET TERMINATED state</codeName>
                  </publicIpInstanceStatus>
                  <publicIpInstanceOperation>
                      <code>NULL</code>
                      <codeName>NET NULL OP</codeName>
                  </publicIpInstanceOperation>
                  <publicIpKindType>
                      <code>GEN</code>
                      <codeName>General</codeName>
                  </publicIpKindType>
                  <serverInstanceAssociatedWithPublicIp />
              </publicIpInstance>
          </publicIpInstanceList>
      </deletePublicIpInstancesResponse>
      

replaceServerInstanceAssociatedWithPublicIp

  • API name

    Replace server instance with Associated public Ip

  • Action

    replaceServerInstanceAssociatedWithPublicIp

  • Description Replace server instance with Associated public Ip

  • Request parameters

Parameter Brief Description Type Limitations Required
publicIpInstanceNo Public IP instance number String Yes
serverInstanceNo Server instance number String Yes
  • publicIpInstanceNo
    • Public IP instance number to replace.
  • serverInstanceNo

    • Server instance number to replace
    • List of server instance numbers you want to associate the public IP address with.
  • Example

    • Request

      ${SERVER_API_URL}/replaceServerInstanceAssociatedWithPublicIp
      ?serverInstanceNo=691083
      &publicIpInstanceNo=662308
      
    • Response

      <replaceServerInstanceAssociatedWithPublicIpResponse>
          <requestId>82d58738-1aae-4677-982f-b194b24a683b</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <publicIpInstanceList>
              <publicIpInstanceNo>662308</publicIpInstanceNo>
              <publicIp>49.236.160.36</publicIp>
              <publicIpDescription>testfsdf</publicIpDescription>
              <createDate>2018-05-23T11:04:38+0900</createDate>
              <publicIpInstanceStatusName>changing</publicIpInstanceStatusName>
              <publicIpInstanceStatus>
                  <code>USED</code>
                  <codeName>NET USED state</codeName>
              </publicIpInstanceStatus>
              <publicIpInstanceOperation>
                  <code>CHANG</code>
                  <codeName>NET CHANGE OP</codeName>
              </publicIpInstanceOperation>
              <publicIpKindType>
                  <code>GEN</code>
                  <codeName>General</codeName>
              </publicIpKindType>
              <serverInstanceAssociatedWithPublicIp>
                  <serverInstanceNo>691083</serverInstanceNo>
                  <serverName>import-key</serverName>
                  <serverDescription></serverDescription>
                  <cpuCount>2</cpuCount>
                  <memorySize>4294967296</memorySize>
                  <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                  <platformType>
                      <code>LNX64</code>
                      <codeName>Linux 64 Bit</codeName>
                  </platformType>
                  <loginKeyName>import-key</loginKeyName>
                  <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                  <publicIp>49.236.160.36</publicIp>
                  <privateIp>10.39.3.136</privateIp>
                  <serverImageName>centos-6.6-64</serverImageName>
                  <serverInstanceStatus>
                      <code>RUN</code>
                      <codeName>Server run state</codeName>
                  </serverInstanceStatus>
                  <serverInstanceOperation>
                      <code>NULL</code>
                      <codeName>Server NULL OP</codeName>
                  </serverInstanceOperation>
                  <serverInstanceStatusName>running</serverInstanceStatusName>
                  <createDate>2018-06-15T11:15:10+0900</createDate>
                  <uptime>2018-06-15T11:15:10+0900</uptime>
                  <serverImageProductCode>SPSW0LINUX000044</serverImageProductCode>
                  <serverProductCode>SPSVRSSD00000003</serverProductCode>
                  <isProtectServerTermination>false</isProtectServerTermination>
                  <portForwardingPublicIp>49.236.160.11</portForwardingPublicIp>
                  <zone>
                      <zoneNo>2</zoneNo>
                      <zoneName>KR-1</zoneName>
                      <zoneDescription>가산 zone</zoneDescription>
                      <regionNo>1</regionNo>
                  </zone>
                  <region>
                      <regionNo>1</regionNo>
                      <regionCode>KR</regionCode>
                      <regionName>Korea</regionName>
                  </region>
                  <baseBlockStorageDiskType>
                      <code>NET</code>
                      <codeName>Network Storage</codeName>
                  </baseBlockStorageDiskType>
                  <baseBlockStorageDiskDetailType>
                      <code>SSD</code>
                      <codeName>SSD</codeName>
                  </baseBlockStorageDiskDetailType>
                  <serverInstanceType>
                      <code>STAND</code>
                      <codeName>Standard</codeName>
                  </serverInstanceType>
                  <userData></userData>
              </serverInstanceAssociatedWithPublicIp>
              <zone>
                  <zoneNo>2</zoneNo>
                  <zoneName>KR-1</zoneName>
                  <zoneDescription>가산 zone</zoneDescription>
                  <regionNo>1</regionNo>
              </zone>
          </publicIpInstanceList>
      </replaceServerInstanceAssociatedWithPublicIpResponse>
      

Port forwarding

getPortForwardingRuleList

  • API name

    Get port forwarding rule list

  • Action

    getPortForwardingRuleList

  • Description

    Gets a list of port forwarding rules.

    When a server is created for the first time, a public IP address for port forwarding is given per account.

  • Request parameters
Parameter Brief Description Type Limitations Required
internetLineTypeCode Internet line type code String Min: 1, Max: 5 No
regionNo Region number String No
zoneNo Zone number String No
  • internetLineTypeCode
    • Internet line type code
    • PUBLC (Public), GLBL (Global)
    • Default: PUBLC (Public)
  • regionNo
    • Get available values using the getRegionList action.
  • zoneNo

    • Get available values using the getZoneList action.
    • Default: The first zone of the region.
  • Example

    • Request

      ${SERVER_API_URL}/getPortForwardingRuleList
      
    • Response

      <getPortForwardingRuleListResponse>
          <requestId>08842664-ea53-49b5-9192-7e4d165b86d6</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <portForwardingConfigurationNo>1676</portForwardingConfigurationNo>
          <portForwardingPublicIp>192.168.120.28</portForwardingPublicIp>
          <totalRows>2</totalRows>
          <portForwardingRuleList>
              <portForwardingRule>
                  <portForwardingExternalPort>1025</portForwardingExternalPort>
                  <portForwardingInternalPort>3389</portForwardingInternalPort>
                  <serverInstance>
                      <serverInstanceNo>274079</serverInstanceNo>
                      <serverName>pjaser-2</serverName>
                      <serverDescription />
                      <cpuCount>1</cpuCount>
                      <memorySize>2147483648</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>WND32</code>
                          <codeName>Windows 32 Bit</codeName>
                      </platformType>
                      <loginKeyName>pja-1126</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp />
                      <privateIp>10.101.6.101</privateIp>
                      <serverImageName>win-2008-32-R1</serverImageName>
                      <serverInstanceStatus>
                          <code>FSTOP</code>
                          <codeName>Server failure stopped state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>repairing</serverInstanceStatusName>
                      <createDate>2015-03-04T15:12:47+0900</createDate>
                      <uptime>2015-03-27T11:36:29+0900</uptime>
                      <serverImageProductCode>SPSW0WINNT000013</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000003</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp>192.168.120.28</portForwardingPublicIp>
                      <portForwardingExternalPort>1025</portForwardingExternalPort>
                      <portForwardingInternalPort>3389</portForwardingInternalPort>
                      <zone>
                          <zoneNo>2</zoneNo>
                          <zoneName>nang_zone</zoneName>
                          <zoneDescription>nang zone</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>NET</code>
                          <codeName>Network Storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>3321</accessControlGroupConfigurationNo>
                              <accessControlGroupName>pja-acg</accessControlGroupName>
                              <accessControlGroupDescription />
                              <isDefault>false</isDefault>
                              <createDate>2015-03-04T15:12:21+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstance>
              </portForwardingRule>
              <portForwardingRule>
                  <portForwardingExternalPort>1026</portForwardingExternalPort>
                  <portForwardingInternalPort>22</portForwardingInternalPort>
                  <serverInstance>
                      <serverInstanceNo>274317</serverInstanceNo>
                      <serverName>x0312b</serverName>
                      <serverDescription />
                      <cpuCount>1</cpuCount>
                      <memorySize>2147483648</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>LNX64</code>
                          <codeName>Linux 64 Bit</codeName>
                      </platformType>
                      <loginKeyName>pja-1126</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp />
                      <privateIp>10.101.6.115</privateIp>
                      <serverImageName>centos-6.3-64</serverImageName>
                      <serverInstanceStatus>
                          <code>FSTOP</code>
                          <codeName>Server failure stopped state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>repairing</serverInstanceStatusName>
                      <createDate>2015-03-12T18:29:39+0900</createDate>
                      <uptime>2015-03-13T10:08:45+0900</uptime>
                      <serverImageProductCode>SPSW0LINUX000031</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000003</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp>192.168.120.28</portForwardingPublicIp>
                      <portForwardingExternalPort>1026</portForwardingExternalPort>
                      <portForwardingInternalPort>22</portForwardingInternalPort>
                      <zone>
                          <zoneNo>2</zoneNo>
                          <zoneName>nang_zone</zoneName>
                          <zoneDescription>nang zone</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>NET</code>
                          <codeName>Network Storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                              <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                              <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                              <isDefault>true</isDefault>
                              <createDate>2013-12-03T10:37:39+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstance>
              </portForwardingRule>
          </portForwardingRuleList>
      </getPortForwardingRuleListResponse>
      

addPortForwardingRules

  • API name

    Add port forwarding rules

  • Action

    addPortForwardingRules

  • Description

    Adds port forwarding rules.

    You can add a port forwarding rule to the server you own and access it with the public IP address for port forwarding.

  • Request parameters

Parameter Brief Description Type Limitations Required
portForwardingConfigurationNo Port forwarding configuration number String Yes
portForwardingRuleList.N.serverInstanceNo Port forwarding rule list.N.server instance number List\ Yes
portForwardingRuleList.N.portForwardingExternalPort Port forwarding rule list.N.port forwarding external port String Min: 1, Max: 65534 Yes
portForwardingRuleList.N.portForwardingInternalPort Port forwarding rule list.N.port forwarding internal port String Min: 1, Max: 65534 Yes
  • portForwardingConfigurationNo
    • Port forwarding configuration number
    • A key value for port forwarding, generated by NAVER CLOUD PLATFORM
  • portForwardingRuleList.N.serverInstanceNo
    • Server instance number for which port forwarding is set
  • portForwardingRuleList.N.portForwardingExternalPort
    • External port for port forwarding
  • portForwardingRuleList.N.portForwardingInternalPort

    • Internal port for port forwarding
    • Only the following ports are available. [Linux: 22 | Windows: 3389]
  • Example

    • Request

      ${SERVER_API_URL}/addPortForwardingRules
      ?portForwardingConfigurationNo=1676
      &portForwardingRuleList.1.serverInstanceNo=274079
      &portForwardingRuleList.1.portForwardingExternalPort=1025
      &portForwardingRuleList.1.portForwardingInternalPort=3389
      
    • Response

      <addPortForwardingRulesResponse>
          <requestId>943e41d1-f2b9-43a9-b308-5f12152a2f7f</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <portForwardingConfigurationNo>1676</portForwardingConfigurationNo>
          <portForwardingPublicIp>192.168.120.28</portForwardingPublicIp>
          <totalRows>2</totalRows>
          <portForwardingRuleList>
              <portForwardingRule>
                  <portForwardingExternalPort>1025</portForwardingExternalPort>
                  <portForwardingInternalPort>3389</portForwardingInternalPort>
                  <serverInstance>
                      <serverInstanceNo>274079</serverInstanceNo>
                      <serverName>pjaser-2</serverName>
                      <serverDescription />
                      <cpuCount>1</cpuCount>
                      <memorySize>2147483648</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>WND32</code>
                          <codeName>Windows 32 Bit</codeName>
                      </platformType>
                      <loginKeyName>pja-1126</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp />
                      <privateIp>10.101.6.101</privateIp>
                      <serverImageName>win-2008-32-R1</serverImageName>
                      <serverInstanceStatus>
                          <code>FSTOP</code>
                          <codeName>Server failure stopped state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>repairing</serverInstanceStatusName>
                      <createDate>2015-03-04T15:12:47+0900</createDate>
                      <uptime>2015-03-27T11:36:29+0900</uptime>
                      <serverImageProductCode>SPSW0WINNT000013</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000003</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp>192.168.120.28</portForwardingPublicIp>
                      <portForwardingExternalPort>1025</portForwardingExternalPort>
                      <portForwardingInternalPort>3389</portForwardingInternalPort>
                      <zone>
                          <zoneNo>2</zoneNo>
                          <zoneName>nang_zone</zoneName>
                          <zoneDescription>nang zone</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>NET</code>
                          <codeName>Network Storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>3321</accessControlGroupConfigurationNo>
                              <accessControlGroupName>pja-acg</accessControlGroupName>
                              <accessControlGroupDescription />
                              <isDefault>false</isDefault>
                              <createDate>2015-03-04T15:12:21+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstance>
              </portForwardingRule>
          </portForwardingRuleList>
      

deletePortForwardingRules

  • API name

    Delete port forwarding rules

  • Action

    deletePortForwardingRules

  • Description

    Deletes port forwarding rules.

    You can delete port forwarding rules from your own servers.

  • Request parameters

Parameter Brief Description Type Limitations Required
portForwardingConfigurationNo Port forwarding configuration number String Yes
portForwardingRuleList.N.serverInstanceNo Port forwarding rule list.N.server instance number List\ Yes
portForwardingRuleList.N.portForwardingExternalPort Port forwarding rule list.N.port forwarding external port Integer Min: 1, Max: 65534 Yes
portForwardingRuleList.N.portForwardingInternalPort Port forwarding rule list.N.port forwarding internal port Integer Min: 1, Max: 65534 Yes
  • portForwardingConfigurationNo
    • Port forwarding configuration number
    • A key value for port forwarding, generated by NAVER CLOUD PLATFORM
  • portForwardingRuleList.N.serverInstanceNo
    • Server instance number for which port forwarding is set, which you want to delete
  • portForwardingRuleList.N.portForwardingExternalPort
    • External port to delete
  • portForwardingRuleList.N.portForwardingInternalPort

    • Internal port to delete
    • Only the following ports are available. [Linux: 22 | Windows: 3389]
  • Example

    • Request

      ${SERVER_API_URL}/deletePortForwardingRules
      ?portForwardingConfigurationNo=1676
      &portForwardingRuleList.1.serverInstanceNo=274079
      &portForwardingRuleList.1.portForwardingExternalPort=1025
      &portForwardingRuleList.1.portForwardingInternalPort=3389
      
    • Response

      <deletePortForwardingRulesResponse>
          <requestId>54b32354-3acb-489c-8bdb-09a722555a75</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <portForwardingConfigurationNo>1676</portForwardingConfigurationNo>
          <portForwardingPublicIp>192.168.120.28</portForwardingPublicIp>
          <totalRows>1</totalRows>
          <portForwardingRuleList>
              <portForwardingRule>
                  <portForwardingExternalPort>1026</portForwardingExternalPort>
                  <portForwardingInternalPort>22</portForwardingInternalPort>
                  <serverInstance>
                      <serverInstanceNo>274317</serverInstanceNo>
                      <serverName>x0312b</serverName>
                      <serverDescription />
                      <cpuCount>1</cpuCount>
                      <memorySize>2147483648</memorySize>
                      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                      <platformType>
                          <code>LNX64</code>
                          <codeName>Linux 64 Bit</codeName>
                      </platformType>
                      <loginKeyName>pja-1126</loginKeyName>
                      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
                      <publicIp />
                      <privateIp>10.101.6.115</privateIp>
                      <serverImageName>centos-6.3-64</serverImageName>
                      <serverInstanceStatus>
                          <code>FSTOP</code>
                          <codeName>Server failure stopped state</codeName>
                      </serverInstanceStatus>
                      <serverInstanceOperation>
                          <code>NULL</code>
                          <codeName>Server NULL OP</codeName>
                      </serverInstanceOperation>
                      <serverInstanceStatusName>repairing</serverInstanceStatusName>
                      <createDate>2015-03-12T18:29:39+0900</createDate>
                      <uptime>2015-03-13T10:08:45+0900</uptime>
                      <serverImageProductCode>SPSW0LINUX000031</serverImageProductCode>
                      <serverProductCode>SPSVRSTAND000003</serverProductCode>
                      <isProtectServerTermination>false</isProtectServerTermination>
                      <portForwardingPublicIp>192.168.120.28</portForwardingPublicIp>
                      <portForwardingExternalPort>1026</portForwardingExternalPort>
                      <portForwardingInternalPort>22</portForwardingInternalPort>
                      <zone>
                          <zoneNo>2</zoneNo>
                          <zoneName>nang_zone</zoneName>
                          <zoneDescription>nang zone</zoneDescription>
                      </zone>
                      <baseBlockStorageDiskType>
                          <code>NET</code>
                          <codeName>Network Storage</codeName>
                      </baseBlockStorageDiskType>
                      <userData />
                      <accessControlGroupList>
                          <accessControlGroup>
                              <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
                              <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
                              <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
                              <isDefault>true</isDefault>
                              <createDate>2013-12-03T10:37:39+0900</createDate>
                          </accessControlGroup>
                      </accessControlGroupList>
                  </serverInstance>
              </portForwardingRule>
          </portForwardingRuleList>
      </deletePortForwardingRulesResponse>
      

Tags

createInstanceTags

  • API name

    create instance tags

  • Action

    createInstanceTags

  • Description

    Create instance tags.

  • Requested parameters
Parameter Brief Description Type Limitations Required
instanceNoList.N Instance number list List\ Duplicates not allowed. Yes
instanceTagList.N.tagKey instanceTagList.N.tagKey List\ Yes
instanceTagList.N.tagValue instanceTagList.N.tagValue List\ Yes
  • instanceNoList.N
    • Instance number list to create instance tags. (Only server)
  • instanceTagList.N.tagKey
    • Tag key of instance tag list to create.
  • instanceTagList.N.tagValue

    • Tag value of instance tag list to create.
  • Example

    • Request

      ${SERVER_API_URL}/createInstanceTags 
      ?instanceNoList.1=937486
      &instanceTagList.1.tagKey=peach
      &instanceTagList.1.tagValue=999999
      
    • Response

      <?xml version="1.0" encoding="UTF-8"?>
      <createInstanceTagsResponse>
        <requestId>0d101bfc-1f68-45c5-aa56-e8def873233d</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <instanceTagList>
          <instanceTag>
            <instanceNo>937486</instanceNo>
            <instanceType>
              <code>SVR</code>
              <codeName>Server</codeName>
            </instanceType>
            <tagKey>peach</tagKey>
            <tagValue>999999</tagValue>
          </instanceTag>
        </instanceTagList>
      </createInstanceTagsResponse>
      

deleteInstanceTags

  • API name

    delete instance tags

  • Action

    deleteInstanceTags

  • Description

    Delete instance tags.

  • Requested parameters

Parameter Brief Description Type Limitations Required
instanceNoList.N Instance number list List\ Duplicates not allowed. Yes
instanceTagList.N.tagKey instanceTagList.N.tagKey List\ No
instanceTagList.N.tagValue instanceTagList.N.tagValue List\ No
  • instanceNoList.N
    • Instance number list to delete instance tags. (Only server)
  • instanceTagList.N.tagKey
    • Tag key of instance tag list to delete.
  • instanceTagList.N.tagValue

    • Tag value of instance tag list to delete.
  • Example

    • Request

      ${SERVER_API_URL}/deleteInstanceTags
      ?instanceNoList.1=937486
      
    • Response

      <?xml version="1.0" encoding="UTF-8"?>
      <deleteInstanceTagsResponse>
        <requestId>7b6e0d85-7c10-4b3f-8686-eb3dba501146</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>0</totalRows>
        <instanceTagList/>
      </deleteInstanceTagsResponse>
      

getInstanceTagList

  • API name

    get instance tag list

  • Action

    getInstanceTagList

  • Description

    Get instance tag list.

  • Requested parameters

Parameter Brief Description Type Limitations Required
instanceNoList.N Instance number list List\ Duplicates not allowed. No
tagKeyList.N Tag key list List\ Duplicates not allowed. No
tagValueList.N Tag value list List\ Duplicates not allowed. No
pageNo Page number Integer No
pageSize Page size Integer No
  • instanceNoList.N
    • Instance number list to get instance tags. (Only server)
  • instanceTagList.N.tagKey
    • Tag key of instance tag list.
  • instanceTagList.N.tagValue
    • Tag value of instance tag list.
  • pageNo
    • Page number based on the page size if the number of items is large.
  • pageSize

    • Number of items to be shown per page
  • Example

    • Request

      ${SERVER_API_URL}/getInstanceTagList
      ?instanceNoList.1=937486
      &tagKeyList.1=gorilla
      
    • Response

      <?xml version="1.0" encoding="UTF-8"?>
      <getInstanceTagListResponse>
        <requestId>bbce4209-306c-4c54-94ce-7dbd37982a76</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <instanceTagList>
          <instanceTag>
            <instanceNo>937486</instanceNo>
            <instanceType>
              <code>SVR</code>
              <codeName>Server</codeName>
            </instanceType>
            <tagKey>gorilla</tagKey>
            <tagValue>77777</tagValue>
          </instanceTag>
        </instanceTagList>
      </getInstanceTagListResponse>
      

に対する検索結果は~件です。 ""

    に対する検索結果がありません。 ""

    処理中...