getServerInstanceList

Prev Next

VPC環境で利用できます。

概要

サーバインスタンス(VM)リストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String - リージョンコード
サーバインスタンスリスト照会対象のリージョン(Region)
regionCodeはgetRegionListアクションを通じて取得可能
デフォルト: getRegionList照会結果の最初のリージョンを選択
vpcNo No String - VPC番号
VPC番号で絞り込んで検索可能
vpcNoはgetVpcListアクションを通じて取得可能
serverInstanceNoList No List<String> - サーバインスタンス番号リスト
サーバインスタンス番号で絞り込んで検索可能
serverInstanceNoはgetServerInstanceListアクションを通じて取得可能
例: --serverInstanceNoList 1234 2345
serverName No String - サーバ名
サーバ名で絞り込んで検索可能
serverInstanceStatusCode No String - サーバインスタンスの状態コード
サーバインスタンスの状態コードで絞り込んで検索可能
オプション: INIT | CREAT | RUN | NSTOP
baseBlockStorageDiskTypeCode No String - 基本ブロックストレージディスクタイプコード
サーバインスタンスの基本ブロックストレージタイプで絞り込んで検索可能
オプション: NET (NETWORK DISK)
baseBlockStorageDiskDetailTypeCode No String - 基本ブロックストレージディスクの詳細タイプコード
サーバインスタンスの基本ブロックストレージの詳細タイプで絞り込んで検索可能
オプション: HDD | SSD
ip No String - IPアドレス
サーバインスタンスの IPアドレスで絞り込んで検索可能
プライベート IPアドレスとパブリック IPアドレスのいずれも絞り込み対象
placementGroupNoList No List<String> - 物理配置グループ番号リスト
サーバインスタンスが属する物理配置グループ番号で絞り込んで検索可能
placementGroupNoはgetPlacementGroupListアクションを通じて取得可能
例: --placementGroupNoList 1234 2345
hypervisorTypeCodeList No List<String> - ハイパーバイザタイプコードリスト
ハイパーバイザタイプで絞り込んで検索可能
オプション: XEN | KVM
例: --hypervisorTypeCodeList KVM XEN
fabricClusterPoolNo No String - Fabric Cluster Pool番号
Fabric Cluster Pool番号で絞り込んで検索可能
fabricClusterPoolNoはgetFabricClusterPoolListアクションを通じて取得可能
fabricClusterNo No String - Fabric Cluster番号
Fabric Cluster番号で絞り込んで検索可能
fabricClusterNoはgetFabricClusterListアクションを通じて取得可能
fabricClusterMode No String - Fabric Clusterモードで絞り込み
オプション: SINGLE | CLUSTER
pageNo No Integer - ページングされた結果のページ番号
結果値を pageNo、pageSizeを利用してページング処理可能
pageSize Conditional Integer - ページング時に表示する各ページサイズ
結果値を pageNo、pageSizeを利用してページング処理可能
pageNo入力時、必ず入力
sortedBy No String - ソート対象
結果値をサーバ名、サーバインスタンス番号でソート可能
オプション: serverName | serverInstanceNo
sortingOrder No String - ソート順序
sortedByの利用時、昇順または降順のソートを設定
オプション: ASC(昇順) | DESC(降順)
デフォルト: ASC
output No String レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: 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;
private List<BlockDevicePartition> blockDevicePartitionList;
private CommonCode hypervisorType;
private String serverImageNo;
private String serverSpecCode;
private List<String> eventList;
private String fabricClusterPoolNo;
private String fabricClusterPoolName;
private String fabricClusterMode;
private String fabricClusterNo;
private String fabricClusterName;
private Boolean isPreInstallGpuDriver;

例

リクエスト例

ncloud vserver getServerInstanceList --regionCode KR --vpcNo ***04 --serverInstanceNoList ***4299 --serverName test-*** --serverInstanceStatusCode RUN --baseBlockStorageDiskTypeCode NET --baseBlockStorageDiskDetailTypeCode SSD --ip ***.***.111.215 --placementGroupNoList ***61

レスポンス例

Serverの場合

{
  "getServerInstanceListResponse": {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "***4299",
        "serverName": "test-***",
        "serverDescription": "",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-***",
        "publicIpInstanceNo": "***7551",
        "publicIp": "***.***.111.215",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server run state"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2020-08-19T15:05:07+0900",
        "uptime": "2020-08-19T15:08:09+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.CNTOS.0703.B050",
        "serverProductCode": "SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "***04",
        "subnetNo": "***43",
        "networkInterfaceNoList": [
          "***87"
        ],
        "initScriptNo": "",
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "placementGroupNo": "***61",
        "placementGroupName": "test-***",
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "serverImageNo": "61",
        "serverSpecCode": "mi2-g3i",
        "eventList": [
          "Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration"
        ]
      }
    ]
  }
}

<getServerInstanceListResponse>
  <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>***7551</publicIpInstanceNo>
      <publicIp>***.***.111.215</publicIp>
      <serverInstanceStatus>
        <code>RUN</code>
        <codeName>Server run state</codeName>
      </serverInstanceStatus>
      <serverInstanceOperation>
        <code>NULL</code>
        <codeName>Server NULL OP</codeName>
      </serverInstanceOperation>
      <serverInstanceStatusName>running</serverInstanceStatusName>
      <createDate>2020-08-19T15:05:07+0900</createDate>
      <uptime>2020-08-19T15:08:09+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></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>
      <hypervisorType>
        <code>KVM</code>
        <codeName>KVM</codeName>
      </hypervisorType>
      <serverImageNo>61</serverImageNo>
      <serverSpecCode>mi2-g3i</serverSpecCode>
      <eventList>
        <string>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</string>
      </eventList>        
    </serverInstance>
  </serverInstanceList>
</getServerInstanceListResponse>

Bare Metalの場合

{
  "getServerInstanceListResponse": {
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "****2594",
        "serverName": "test-***",
        "serverDescription": "test",
        "cpuCount": 64,
        "memorySize": 2199023255552,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-***",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "サーバ RUN状態"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "サーバ NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2025-12-12T13:36:17+0900",
        "uptime": "2026-01-05T10:29:51+0900",
        "serverImageProductCode": "SW.VSVR.BM.OS.LNX64.UBNTU.SVR24.WRKND.G001",
        "serverProductCode": "SVR.VSVR.BM.GPU.H200N10.G008.C064.M2048.LOCAL.SSD.B48145.G001",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "***84",
        "subnetNo": "***54",
        "networkInterfaceNoList": [
          "***143"
        ],
        "serverInstanceType": {
          "code": "BM",
          "codeName": "BareMetal"
        },
        "baseBlockStorageDiskType": {
          "code": "LOCAL",
          "codeName": "Localストレージ"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "BM",
          "codeName": "BM"
        },
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterMode": "SINGLE",
        "isPreInstallGpuDriver": false
      }
    ],
    "requestId": "b340fcb4-74b1-4223-ab36-b8c1b67c56f1",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getServerInstanceListResponse>
    <totalRows>1</totalRows>
    <serverInstanceList>
        <serverInstance>
            <serverInstanceNo>****2594</serverInstanceNo>
            <serverName>test-***</serverName>
            <serverDescription>test</serverDescription>
            <cpuCount>64</cpuCount>
            <memorySize>2199023255552</memorySize>
            <platformType>
                <code>LNX64</code>
                <codeName>Linux 64 Bit</codeName>
            </platformType>
            <loginKeyName>test-***</loginKeyName>
            <serverInstanceStatus>
                <code>RUN</code>
                <codeName>サーバ RUN状態</codeName>
            </serverInstanceStatus>
            <serverInstanceOperation>
                <code>NULL</code>
                <codeName>サーバ NULL OP</codeName>
            </serverInstanceOperation>
            <serverInstanceStatusName>running</serverInstanceStatusName>
            <createDate>2025-12-12T13:36:17+0900</createDate>
            <uptime>2026-01-05T10:29:51+0900</uptime>
            <serverImageProductCode>SW.VSVR.BM.OS.LNX64.UBNTU.SVR24.WRKND.G001</serverImageProductCode>
            <serverProductCode>SVR.VSVR.BM.GPU.H200N10.G008.C064.M2048.LOCAL.SSD.B48145.G001</serverProductCode>
            <isProtectServerTermination>false</isProtectServerTermination>
            <zoneCode>KR-1</zoneCode>
            <regionCode>KR</regionCode>
            <vpcNo>***84</vpcNo>
            <subnetNo>***54</subnetNo>
            <networkInterfaceNoList>
                <networkInterfaceNo>***143</networkInterfaceNo>
            </networkInterfaceNoList>
            <serverInstanceType>
                <code>BM</code>
                <codeName>BareMetal</codeName>
            </serverInstanceType>
            <baseBlockStorageDiskType>
                <code>LOCAL</code>
                <codeName>Localストレージ</codeName>
            </baseBlockStorageDiskType>
            <baseBlockStorageDiskDetailType>
                <code>SSD</code>
                <codeName>SSD</codeName>
            </baseBlockStorageDiskDetailType>
            <hypervisorType>
                <code>BM</code>
                <codeName>BM</codeName>
            </hypervisorType>
            <fabricClusterPoolNo>***01</fabricClusterPoolNo>
            <fabricClusterPoolName>test-***</fabricClusterPoolName>
            <fabricClusterMode>SINGLE</fabricClusterMode>
            <isPreInstallGpuDriver>false</isPreInstallGpuDriver>
        </serverInstance>
    </serverInstanceList>
    <requestId>b340fcb4-74b1-4223-ab36-b8c1b67c56f1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</getServerInstanceListResponse>