getServerInstanceList
- 印刷する
- PDF
getServerInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
サーバインスタンス(VM)リストを照会します。ページング処理が可能であり、レスポンスフィールドの中でuserDataの場合はサーバインスタンス詳細照会の時のみ提供されます。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| serverInstanceNoList.N | No | List<String> | 照会するサーバインスタンス番号リスト serverInstanceNoはgetServerInstanceListアクションを通じて取得できます。 ex) serverInstanceNoList.1=937507&serverInstanceNoList.2=1021003 | |
| searchFilterName | No | String | 検索するフィルタ名 サーバ名とIPアドレスでフィルタリングして検索できます。 IPアドレスの場合は、プライベートIP、グローバルIPの両方検索できます。 Options : serverName (サーバ名) | ip (IPアドレス) [大小文字区分なし]searchFilterNameは以下のsearchFilterValue値とmappingして使います。 ex) searchFilterName=ip&searchFilterValue=10.41.3.81 ex) searchFilterName=serverName&searchFilterValue=monkeys | |
| searchFilterValue | No | String | 検索するフィルタ値 上記のsearchFilterName値とmappingする値を入力します。 | |
| pageNo | No | Integer | Min:0, Max:2147483647 | ページングされた結果のページ番号 結果値を、pageNoを利用してページング処理することが可能です。 |
| pageSize | No | Integer | Min:0, Max:2147483647 | ページングする時に表示する各ページサイズ 結果値を、pageNoを利用してページング処理することが可能です。 |
| serverInstanceStatusCode | No | String | Min:0, Max:5 | サーバインスタンスステータスコード 照会するサーバインスタンスステータスコード別のサーバリスト serverInstanceStatusCode getServerInstanceListアクションを通じて取得できます。 入力できるステータスは、サーバインスタンスデータタイプ(ServerInstance)のサーバインスタンスステータス(serverInstanceStatus)値をご参考ください。 ex) serverInstanceStatusCode=NSTOP |
| regionNo | No | String | リージョン番号 サーバリストが照会されるリージョン(Region)を決定できます。 regionNoはgetRegionListアクションを通じて取得できます。 | |
| zoneNo | No | String | ZONE番号 サーバリストが照会されるゾーン(zone)を決定できます。 zoneNoはgetZoneListアクションを通じて取得できます。 default : 該当するリージョンの1番目のゾーン(zone)を選択 | |
| baseBlockStorageDiskTypeCode | No | String | Min : 1, Max : 5 | サーバディスクタイプ区分コード Options : NET (NETWORK DISK) | LOCAL (LOCAL DISK) |
| baseBlockStorageDiskDetailTypeCode | No | String | Min : 1, Max : 5 | サーバディスク詳細タイプ区分コード Options : HDD | SSD |
| sortedBy | No | String | ソート対象 サーバ名とサーバインスタンス番号でソートできます。 Options : serverName (サーバ名) | serverInstanceNo (サーバインスタンス番号) [大小文字区分なし]default : serverInstanceNo sortedByは以下のsortingOrderとmappingして使います。 ex) sortedBy=serverName&sortingOrder=ascending ex) sortedBy=serverInstanceNo&sortingOrder=descending | |
| sortingOrder | No | String | ソート順番 上記で設定したsortedByのアセンディング/ディセンディングソートを設定します。 ascending (アセンディング) | descending (ディセンディング) [大小文字区分なし]default : ascending | |
| serverInstanceTypeCodeList.N | No | List<String> | 照会するサーバインスタンス区分コードリスト 入力できるステータスは、サーバインスタンスデータタイプ(ServerInstance)のサーバインスタンスタイプ(serverInstanceType)値をご参考ください。 Options : MICRO (Micro) | COMPT (Compact) | STAND(Standard) | HIMEM(High Memory) | GPU(GPU) | VDS (Virtual Dedicated Server) | |
| tagKeyList.N | No | List<String> | 照会するインスタンスタグのキー インスタンスタグキーを通じてインスタンスを照会できます。 InstanceのTagKeyはgetInstanceTagListアクションを通じて取得できます。 ex) instanceTagList.1.tagKey=tag1 | |
| tagKeyValue.N | No | List<String> | 照会するインスタンスのタグ値 インスタンスのタグ値を通じてインスタンスを照会できます。 InstanceのTagValueはgetInstanceTagListアクションを通じて取得できます。 ex) instanceTagList.1.tagValue=dolphins |
レスポンス
レスポンスボディ
例示
リクエスト例示
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>平村zone</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>
この記事は役に立ちましたか?