MENU
      stopServerInstances

        stopServerInstances


        Article summary

        Can be used in a VPC environment.

        Overview

        It stops the server instance (VM) in operation.

        Request

        Request parameters

        Parameter nameRequiredTypeRestrictionsDescription
        regionCodeNoStringRegion code
        You can decide the region of server instance to be stopped.
        regionCode can be obtained through the getRegionList action.
        Default: Select the first region of the getRegionList search results
        serverInstanceNoList.NYesList<String>List of the server instance numbers to be stopped
        serverInstanceNo can be obtained through the getServerInstanceList action.
        ex) serverInstanceNoList.1=1234&serverInstanceNoList.2=2345
        responseFormatTypeNoStringFormat type of the response results
        Options : xml | json
        Default : xml

        Response

        Response body

        Example

        Request Example

        GET {API_URL}/stopServerInstances
        ?regionCode=KR
        &serverInstanceNoList.1=***4299
        HTTP

        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>
        XML

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.