stopServerInstances
- Print
- PDF
stopServerInstances
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Overview
Stop the server instance (VM) in operation.
Request
Request parameter
| Parameter Name | Required Status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region Code You can decide the region of the server instance to be stopped. The regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList query results. | |
| serverInstanceNoList.N | Yes | List<String> | List of the server instance numbers to be stopped The serverInstanceNo can be obtained through the getServerInstanceList action. ex) --serverInstanceNoList 1234 2345 | |
| responseFormatType | No | String | Format type for the response result Options : xml | json Default : xml |
Response
Response data type
- ServerInstanceList type
| ServerInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<ServerInstance> serverInstanceList = new ArrayList<>(); |
| ServerInstance |
|---|
| private String serverInstanceNo; |
| private String serverName; |
| private String serverDescription; |
| private Integer cpuCount; |
| private Long memorySize; |
| private CommonCode platformType; |
| private String loginKeyName; |
| private String publicIpInstanceNo; |
| private String publicIp; |
| 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 zoneCode; |
| private String regionCode; |
| private String vpcNo; |
| private String subnetNo; |
| private NetworkInterfaceNoList networkInterfaceNoList; |
| private String initScriptNo; |
| private CommonCode serverInstanceType; |
| private CommonCode baseBlockStorageDiskType; |
| private CommonCode baseBlockStorageDiskDetailType; |
| private String placementGroupNo; |
| private String placementGroupName; |
| private String memberServerImageInstanceNo; |
Example
Request example
ncloud vserver stopServerInstances --regionCode KR --serverInstanceNoList ***4299
Response example
<stopServerInstancesResponse>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<serverInstanceList>
<serverInstance>
<serverInstanceNo>***4299</serverInstanceNo>
<serverName>test-***</serverName>
<serverDescription></serverDescription>
<cpuCount>2</cpuCount>
<memorySize>4294967296</memorySize>
<platformType>
<code>LNX64</code>
<codeName>Linux 64 Bit</codeName>
</platformType>
<loginKeyName>test-***</loginKeyName>
<publicIpInstanceNo></publicIpInstanceNo>
<publicIp></publicIp>
<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>2020-08-24T09:41:23+0900</createDate>
<uptime>2020-08-24T09:51:26+0900</uptime>
<serverImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</serverImageProductCode>
<serverProductCode>SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<zoneCode>KR-1</zoneCode>
<regionCode>KR</regionCode>
<vpcNo>***04</vpcNo>
<subnetNo>***43</subnetNo>
<networkInterfaceNoList>
<networkInterfaceNo>***87</networkInterfaceNo>
</networkInterfaceNoList>
<initScriptNo>***44</initScriptNo>
<serverInstanceType>
<code>STAND</code>
<codeName>Standard</codeName>
</serverInstanceType>
<baseBlockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</baseBlockStorageDiskType>
<baseBlockStorageDiskDetailType>
<code>SSD</code>
<codeName>SSD</codeName>
</baseBlockStorageDiskDetailType>
<placementGroupNo>***61</placementGroupNo>
<placementGroupName>test-***</placementGroupName>
</serverInstance>
</serverInstanceList>
</stopServerInstancesResponse>
Was this article helpful?