getServerInstanceList

Prev Next

概要

サーバインスタンスリストを照会

説明

サーバインスタンス(VM)リストを照会します。
ページング処理が可能で、レスポンス項目のうち userDataはサーバインスタンスの詳細照会時のみ提供されます。

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
serverInstanceNoList No List<String> 照会対象のサーバインスタンス番号リスト
searchFilterName No String サーバ名(serverName) | アイピー(ipアドレス) [大文字・小文字の区別なし]
アイピー(ipアドレス)の場合、プライベート IPアドレスとグローバル IPアドレスのいずれも使用可能
searchFilterValue No String 検索対象の値
pageNo No Integer 最小: 0, 最大:2147483647 件数が多い場合、ページサイズに当たるページ番号
pageSize No Integer 最小:0, 最大:2147483647 1ページで照会するページサイズ
serverInstanceStatusCode No String 最小:0, 最大:5 - 照会対象のサーバインスタンス状態コード別サーバリスト
入力可能な状態は、サーバインスタンスデータタイプ(ServerInstance)のサーバインスタンス状態
(serverInstanceStatus)の値を参照
regionNo No String 入力可能な状態は、getRegionListアクションを通じて取得可能
zoneNo No String サーバリストが照会される ZONEを決定可能
getZoneListアクションを通じて取得可能
デフォルト: そのリージョンの最初の ZONEを選択
baseBlockStorageDiskTypeCode No String 最小: 1, 最大: 5 - サーバディスクタイプ区分コード
NETWORK DISK(NET) | LOCAL DISK(LOCAL)
baseBlockStorageDiskDetailTypeCode No String 最小: 1, 最大: 5 - サーバディスクの詳細タイプ区分コード
ハードディスク(HDD) | SSD(SSD)
sortedBy No String サーバ名(serverName) | サーバインスタンス番号(serverInstanceNo) [大文字・小文字の区別なし]
デフォルト: サーバインスタンス番号(serverInstanceNo)
sortingOrder No String 昇順(ascending) | 降順(descending) [大文字・小文字の区別なし]
デフォルト: 昇順(ascending)
serverInstanceTypeCodeList No List<String> - 照会対象のサーバインスタンス区分コードリスト
Micro(MICRO) | Compact(COMPT) | Standard(STAND) | High Memory(HIMEM) | GPU(GPU) | Virtual Dedicated Server(VDS)
tagKeyList No List<String> 照会対象のタグキーリスト
tagValueList No List<String> 照会対象のタグ値リスト

レスポンスデータタイプ

  • ServerInstanceListタイプ
ServerInstanceList extends CommonResponse
private Integer totalRows;
private List<ServerInstance> serverInstanceList = new ArrayList<ServerInstance>();
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 List<AccessControlGroup> accessControlGroupList;
private List<InstanceTag> instanceTagList;
private List<BlockDevicePartition> blockDevicePartitionList;

例

呼び出し 

ncloud server getServerInstanceList --serverInstanceStatusCode NSTOP --regionNo 2

レスポンス 

{
  "getServerInstanceListResponse": {
    "requestId": "164236f2-effd-4103-96ef-5631de14f5fc",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 2,
    "serverInstanceList": [
      {
        "serverInstanceNo": "324429",
        "serverName": "test-muk",
        "serverDescription": "",
        "cpuCount": 1,
        "memorySize": 2147483648,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "yskey",
        "isFeeChargingMonitoring": false,
        "publicIp": "192.168.10.128",
        "privateIp": "10.113.201.174",
        "serverImageName": "centos-5.7-64",
        "serverInstanceStatus": {
          "code": "NSTOP",
          "codeName": "Server normal stopped state"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "stopped",
        "createDate": "2017-05-19T12:07:12+0900",
        "uptime": "2017-05-23T16:56:45+0900",
        "serverImageProductCode": "SPSW0LINUX000010",
        "serverProductCode": "SPSVRSTAND000003",
        "isProtectServerTermination": false,
        "portForwardingPublicIp": "192.168.10.100",
        "zone": {
          "zoneNo": "10",
          "zoneName": "USW-1",
          "zoneDescription": "1st zone"
        },
        "region": {
          "regionNo": "2",
          "regionCode": "USW",
          "regionName": "US-West"
        },
        "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"
          }
        ]
      },
      {
        "serverInstanceNo": "394180",
        "serverName": "mssong-test",
        "serverDescription": "",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "baseBlockStorageSize": 53687091200,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "redis-web",
        "isFeeChargingMonitoring": false,
        "publicIp": "",
        "privateIp": "10.113.201.150",
        "serverImageName": "centos-6.3-64",
        "serverInstanceStatus": {
          "code": "NSTOP",
          "codeName": "Server normal stopped state"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "stopped",
        "createDate": "2017-12-27T23:56:58+0900",
        "uptime": "2017-12-28T00:03:58+0900",
        "serverImageProductCode": "SPSW0LINUX000031",
        "serverProductCode": "SPSVRSTAND000004",
        "isProtectServerTermination": false,
        "portForwardingPublicIp": "192.168.10.100",
        "zone": {
          "zoneNo": "10",
          "zoneName": "USW-1",
          "zoneDescription": "1st zone"
        },
        "region": {
          "regionNo": "2",
          "regionCode": "USW",
          "regionName": "US-West"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStroageDiskDetailType": {
          "code": "HDD",
          "codeName": "HDD"
        },
        "serverInstanceType": {
          "code": "STAND"
          "codeName": "Standard"
        },
        "userData": "",
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "1038",
            "accessControlGroupName": "ncloud-default-acg",
            "accessControlGroupDescription": "Default AccessControlGroup",
            "isDefault": true,
            "createDate": "2013-12-03T10:37:39+0900"
          }
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<getServerInstanceListResponse>
  <requestId>581b7b0d-2046-4222-ae16-1ffcfc166e79</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverInstanceList>
    <serverInstance>
      <serverInstanceNo>1289694</serverInstanceNo>
      <serverName>ncloud-mktest</serverName>
      <serverDescription></serverDescription>
      <cpuCount>1</cpuCount>
      <memorySize>2147483648</memorySize>
      <baseBlockStorageSize>53687091200</baseBlockStorageSize>
      <platformType>
        <code>LNX64</code>
        <codeName>Linux 64 Bit</codeName>
      </platformType>
      <loginKeyName>beagle</loginKeyName>
      <isFeeChargingMonitoring>false</isFeeChargingMonitoring>
      <publicIp></publicIp>
      <privateIp>10.41.84.156</privateIp>
      <serverImageName>centos-7.3-64</serverImageName>
      <serverInstanceStatus>
        <code>RUN</code>
        <codeName>Server run state</codeName>
      </serverInstanceStatus>
      <serverInstanceOperation>
        <code>NULL</code>
        <codeName>Server NULL OP</codeName>
      </serverInstanceOperation>
      <serverInstanceStatusName>running</serverInstanceStatusName>
      <createDate>2019-02-22T15:03:49+0900</createDate>
      <uptime>2019-02-22T15:07:30+0900</uptime>
      <serverImageProductCode>SPSW0LINUX000046</serverImageProductCode>
      <serverProductCode>SPSVRSTAND000003</serverProductCode>
      <isProtectServerTermination>false</isProtectServerTermination>
      <portForwardingPublicIp>106.10.59.225</portForwardingPublicIp>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>坪村ゾーン</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>
      <baseBlockStorageDiskDetailType>
        <code>HDD</code>
        <codeName>HDD</codeName>
      </baseBlockStorageDiskDetailType>
      <serverInstanceType>
        <code>COMPT</code>
        <codeName>Compact Server</codeName>
      </serverInstanceType>
      <userData></userData>
      <initScriptNo></initScriptNo>
      <accessControlGroupList>
        <accessControlGroup>
          <accessControlGroupConfigurationNo>4371</accessControlGroupConfigurationNo>
          <accessControlGroupName>ncloud-default-acg</accessControlGroupName>
          <accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
          <isDefault>true</isDefault>
          <createDate>2017-02-16T14:25:15+0900</createDate>
        </accessControlGroup>
      </accessControlGroupList>
      <instanceTagList/>
    </serverInstance>
  </serverInstanceList>
</getServerInstanceListResponse>