stopServerInstances

Prev Next

Overview

Stop a server instance (VM).

Request

Request parameters

Parameter name Required Type Restrictions Description
serverInstanceNoList.N Yes List<String> It can't be duplicated. - Server instance number to stop
serverInstanceNo can be obtained through the getServerInstanceList action.
e.g., serverInstanceNoList.1=937507&serverInstanceNoList.2=1021003
responseFormatType No String - Response result's format type
Options: xml | json
Default: xml

Response

Response body

Examples

Request example

GET {SERVER_API_URL}/stopServerInstances
?serverInstanceNoList.1=1021003

Response example

<stopServerInstancesResponse>
  <requestId>ee1a0910-96d2-41ca-8a1b-837f889667a2</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstance>
      <serverInstanceNo>1021003</serverInstanceNo>
      <serverName>s1669aa4e78c</serverName>
      <serverDescription>My server image copy error test</serverDescription>
      <cpuCount>2</cpuCount>
      <memorySize>4294967296</memorySize>
      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
      <platformType>
        <code>LNX64</code>
        <codeName>Linux 64 Bit</codeName>
      </platformType>
      <loginKeyName>juhoon-kim</loginKeyName>
      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
      <publicIp>106.10.46.237</publicIp>
      <privateIp>10.41.3.81</privateIp>
      <serverImageName>tensorflow-centos-7.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>2018-10-22T16:19:50+0900</createDate>
      <uptime>2018-11-23T17:38:44+0900</uptime>
      <serverImageProductCode>SPSW0LINUX000066</serverImageProductCode>
      <serverProductCode>SPSVRSSD00000003</serverProductCode>
      <isProtectServerTermination>false</isProtectServerTermination>
      <portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>Pyeongchon 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>
      <initScriptNo></initScriptNo>
      <accessControlGroupList>
        <accessControlGroup>
          <accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
          <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
          <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
          <isDefault>true</isDefault>
          <createDate>2018-04-09T11:12:54+0900</createDate>
        </accessControlGroup>
      </accessControlGroupList>
      <instanceTagList/>
    </serverInstance>
  </serverInstanceList>
</stopServerInstancesResponse>

Errors

Errors that may occur while using this action are listed below. For more information about common errors, see NAVER Cloud Platform API.

HTTP Response Code Return code Return message
400 22001 {1} among {0} servers failed for operation. The problem is being handled. Please hold for a moment.
400 24109 The input parameter instance number is invalid.
400 24120 The input parameter server instance number is invalid.
400 25014 Unable to control the server since (other) user is currently operating storage allocated to the server.
400 25041 Unable to perform operation command since (other) user is either manipulating the target server or a problem in target server. Please confirm server status once again.
400 28005 Unable to perform suspension command since target server is already suspended. (Other) user might have suspended the server by connecting through terminal. Please confirm the server status once again.