Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

stopServerInstances

Prev Next

VPC環境で利用できます。

概要

運用中状態のサーバインスタンス(VM)を停止します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionCode No String リージョンコード
停止するサーバインスタンスのリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default:getRegionList照会結果の最初のリージョンを選択
serverInstanceNoList.N Yes List<String> 停止するサーバインスタンス番号リスト
serverInstanceNoはgetServerInstanceListアクションを通じて取得できます。
ex)--serverInstanceNoList 1234 2345
output No String レスポンス結果の形式タイプ
  • Options : xml | json
  • Default : json

レスポンス

レスポンスデータタイプ

  • ServerInstanceListタイプ
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;

リクエスト例

ncloud vserver stopServerInstances --regionCode KR --serverInstanceNoList ***4299

レスポンス例

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