サーバインスタンス(VM)リストを照会します。ページング処理が可能で、レスポンスフィールドのうち userDataはサーバインスタンスの詳細照会時のみ提供されます。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
|---|---|---|---|---|
| serverInstanceNoList.N | No | List<String> | - 照会対象のサーバインスタンス番号リスト serverInstanceNoは getServerInstanceListアクションを通じて取得可能 例) serverInstanceNoList.1=937507&serverInstanceNoList.2=1021003 |
|
| searchFilterName | No | String | - 検索時に適用するフィルタ名 サーバ名とアイピー(ipアドレス)で絞り込み検索可能 アイピー(ipアドレス)の場合、プライベート IPアドレス、グローバル IPアドレスとも検索可能 オプション: serverName (サーバ名) | ip (IPアドレス) [大文字小文字を区別しない]searchFilterNameは、以下の searchFilterValueと mappingして使用 例: searchFilterName=ip&searchFilterValue=10.41.3.81 例) searchFilterName=serverName&searchFilterValue=monkeys |
|
| searchFilterValue | No | String | - 検索時に適用するフィルタの値 上記の searchFilterName値と mappingする値を入力 |
|
| pageNo | No | Integer | 最小: 0, 最大: 2147483647 | - ページングされた結果のページ番号 結果値は pageNoを利用してページング処理できる |
| pageSize | No | Integer | 最小: 0, 最大: 2147483647 | - ページング時に表示する各ページサイズ 結果値は pageSizeを利用してページング処理できる |
| serverInstanceStatusCode | No | String | 最小: 0, 最大: 5 | - サーバインスタンスの状態コード 照会対象サーバインスタンスの状態コード別サーバリスト serverInstanceStatusCode getServerInstanceListアクションを通じて取得 入力可能な状態は、サーバインスタンスデータタイプ(ServerInstance)のサーバインスタンス状態(serverInstanceStatus)を参照 例) serverInstanceStatusCode=NSTOP |
| regionNo | No | String | - リージョン番号 サーバリスト照会対象のリージョン(Region)を決める regionNoは getRegionListアクションを通じて取得可能 |
|
| zoneNo | No | String | - ZONE番号 サーバリスト照会対象のゾーン(zone)を決める zoneNoは getZoneListアクションを通じて取得可能 デフォルト: そのリージョンの最初のゾーン(zone)を選択 |
|
| baseBlockStorageDiskTypeCode | No | String | 最小: 1, 最大: 5 | - サーバディスクタイプ区分コード オプション: NET (NETWORK DISK) |
| baseBlockStorageDiskDetailTypeCode | No | String | 最小: 1, 最大: 5 | - サーバディスク詳細タイプ区分コード オプション: HDD | SSD |
| sortedBy | No | String | - ソート対象 サーバ名とサーバインスタンス番号でソート オプション: serverName (サーバ名) | serverInstanceNo (サーバインスタンス番号) [大文字小文字を区別しない]デフォルト: serverInstanceNo sortedByは、以下の sortingOrderと mappingして使用 例: sortedBy=serverName&sortingOrder=ascending 例) sortedBy=serverInstanceNo&sortingOrder=descending |
|
| sortingOrder | No | String | - ソート順序 上記で設定した sortedByの昇順/降順ソート設定 ascending (昇順) | descending (降順) [大文字小文字を区別しない]デフォルト: ascending |
|
| serverInstanceTypeCodeList.N | No | List<String> | - 照会対象のサーバインスタンス区分コードリスト 入力可能な状態は、サーバインスタンスデータタイプ(ServerInstance)のサーバインスタンスタイプ(serverInstanceType)を参照 オプション: MICRO (Micro) | COMPT (Compact) | STAND(Standard) | HIMEM(High Memory) | GPU(GPU) | VDS (Virtual Dedicated Server) |
|
| tagKeyList.N | No | List<String> | - 照会対象インスタンスのタグキー インスタンスのタグキーを使用してインスタンスを照会できる Instanceの TagKeyは getInstanceTagListアクションを通じて取得可能 例) instanceTagList.1.tagKey=tag1 |
|
| tagKeyValue.N | No | List<String> | - 照会対象インスタンスのタグ値 インスタンスのタグ値を使用してインスタンスを照会できる Instanceの TagValueは getInstanceTagListアクションを通じて取得可能 例) instanceTagList.1.tagValue=dolphins |
|
| responseFormatType | No | String | - レスポンス結果の形式タイプ オプション: xml | json デフォルト: xml |
レスポンス
レスポンスボディ
例
リクエスト例
GET {SERVER_API_URL}/getServerInstanceList
?serverInstanceStatusCode=RUN
&searchFilterName=ip
&searchFilterValue=106.10.46.237
レスポンス例
<getServerInstanceListResponse>
<requestId>0cf1cb98-6fdb-4064-804d-c1a14f903d9b</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<serverInstanceList>
<serverInstance>
<serverInstanceNo>1081368</serverInstanceNo>
<serverName>s1673fa87a9b</serverName>
<serverDescription></serverDescription>
<cpuCount>1</cpuCount>
<memorySize>1073741824</memorySize>
<baseBlockStorageSize>53687091200</baseBlockStorageSize>
<platformType>
<code>LNX32</code>
<codeName>Linux 32 Bit</codeName>
</platformType>
<loginKeyName>juhoon-kim</loginKeyName>
<isFeeChargingMonitoring>false</isFeeChargingMonitoring>
<publicIp></publicIp>
<privateIp>10.41.19.248</privateIp>
<serverImageName>centos-6.3-32</serverImageName>
<serverInstanceStatus>
<code>NSTOP</code>
<codeName>Server normal stopped state</codeName>
</serverInstanceStatus>
<serverInstanceOperation>
<code>NULL</code>
<codeName>Server NULL OP</codeName>
</serverInstanceOperation>
<serverInstanceStatusName>stopped</serverInstanceStatusName>
<createDate>2018-11-23T17:21:05+0900</createDate>
<uptime>2018-11-23T17:36:40+0900</uptime>
<serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
<serverProductCode>SPSVRSTAND000056</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<portForwardingPublicIp>106.10.51.90</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>MICRO</code>
<codeName>Micro Server</codeName>
</serverInstanceType>
<userData></userData>
<initScriptNo></initScriptNo>
<accessControlGroupList>
<accessControlGroup>
<accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
<accessControlGroupName>ncloud-default-acg</accessControlGroupName>
<accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
<isDefault>true</isDefault>
<createDate>2018-04-09T11:12:54+0900</createDate>
</accessControlGroup>
</accessControlGroupList>
<instanceTagList/>
</serverInstance>
</serverInstanceList>
</getServerInstanceListResponse>