stopServerInstances

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Stopping a server instance

Description

Stop a server instance (VM).

Request Parameters

Parameter Name	Requiredness	Type	Limitation	Description
serverInstanceNoList	Yes	String	Repeat not allowed	Server instance No. to be stopped

Response Data Type

ServerInstanceList type

ServerInstanceList extends CommonResponse
private Integer totalRows;
private List serverInstanceList = new ArrayList();

ServerInstance
private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private Long baseBlockStorageSize;
private CommonCode platformType;
private String loginKeyName;
private Boolean isFeeChargingMonitoring;
private String publicIp;
private String privateIp;
private String serverImageName;
private CommonCode serverInstanceStatus;
private CommonCode serverInstanceOperation;
private String serverInstanceStatusName;
private Date createDate;
private Date uptime;
private String serverImageProductCode;
private String serverProductCode;
private Boolean isProtectServerTermination;
private String portForwardingPublicIp;
private Integer portForwardingExternalPort;
private Integer portForwardingInternalPort;
private Zone zone;
private Region region;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStorageDiskDetailType;
private CommonCode serverInstanceType
private String userData;
private String initScriptNo;
private List accessControlGroupList;
private List instanceTagList;
private List blockDevicePartitionList;

Examples

Request

ncloud server stopServerInstances --serverInstanceNoList 397364

Response

{
  "stopServerInstancesResponse": {
    "requestId": "a0c960b4-b1fb-4f31-b9f5-bd5c15f160c8",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "397364",
        "serverName": "ncloud-mktest3",
        "serverDescription": "",
        "cpuCount": 1,
        "memorySize": 2147483648,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "ysw",
        "isFeeChargingMonitoring": false,
        "publicIp": "",
        "privateIp": "10.113.245.164",
        "serverImageName": "centos-7.3-64",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN State"
        },
        "serverInstanceOperation": {
          "code": "SHTDN",
          "codeName": "Server SHUTDOWN OP"
        },
        "serverInstanceStatusName": "shutting down",
        "createDate": "2018-02-23T15:44:59+0900",
        "uptime": "2018-02-23T15:47:24+0900",
        "serverImageProductCode": "SPSW0LINUX000046",
        "serverProductCode": "SPSVRSTAND000003",
        "isProtectServerTermination": false,
        "portForwardingPublicIp": "192.168.120.111",
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo": "1"
        },
        "region": {
          "regionNo": "1",
          "regionCode": "KR",
          "regionName": "Korea"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStroageDiskDetailType": {
          "code": "HDD",
          "codeName": "HDD"
        },
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "userData": "",
        "initScriptNo": "",
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "1038",
            "accessControlGroupName": "ncloud-default-acg",
            "accessControlGroupDescription": "Default AccessControlGroup",
            "isDefault": true,
            "createDate": "2013-12-03T10:37:39+0900"
          }
        ],
        "instanceTagList" : []
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<stopServerInstancesResponse>
  <requestId>a0c960b4-b1fb-4f31-b9f5-bd5c15f160c8</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstanceNo>397364</serverInstanceNo>
    <serverName>ncloud-mktest3</serverName>
    <serverDescription></serverDescription>
    <cpuCount>1</cpuCount>
    <memorySize>2147483648</memorySize>
    <baseBlockStorageSize>53687091200</baseBlockStorageSize>
    <platformType>
      <code>LNX64</code>
      <codeName>Linux 64 Bit</codeName>
    </platformType>
    <loginKeyName>ysw</loginKeyName>
    <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
    <publicIp></publicIp>
    <privateIp>10.113.245.164</privateIp>
    <serverImageName>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-02-23T15:44:59+0900</createDate>
    <uptime>2018-02-23T15:47:24+0900</uptime>
    <serverImageProductCode>SPSW0LINUX000046</serverImageProductCode>
    <serverProductCode>SPSVRSTAND000003</serverProductCode>
    <isProtectServerTermination>false</isProtectServerTermination>
    <portForwardingPublicIp>192.168.120.111</portForwardingPublicIp>
    <zone>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 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>
    <baseBlockStroageDiskDetailType>
      <code>HDD</code>
      <codeName>HDD</codeName>
    </baseBlockStroageDiskDetailType>
    <serverInstanceType>
      <code>STAND</code>
      <codeName>Standard</codeName>
    </serverInstanceType>
    <userData></userData>
    <initScriptNo></initScriptNo>
    <accessControlGroupList>
      <accessControlGroupConfigurationNo>1038</accessControlGroupConfigurationNo>
      <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
      <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
      <isDefault>true</isDefault>
      <createDate>2013-12-03T10:37:39+0900</createDate>
    </accessControlGroupList>
    <instanceTagList/>
  </serverInstanceList>
</stopServerInstancesResponse>

Was this article helpful?

What's Next

getInitScriptList

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples