getServerInstanceList
- 印刷する
- PDF
getServerInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
概要
サーバインスタンス(VM)リストを照会します。
リクエスト
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| regionCode | No | String | - リージョンコード サーバインスタンスのリストが照会されるリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得可能 Default: getRegionList照会結果の最初のリージョンを選択 | |
| vpcNo | No | String | - VPC番号 VPC番号でフィルタリングして検索できる vpcNoは、getVpcListアクションを通じて取得可能 | |
| serverInstanceNoList.N | No | List<String> | - サーバインスタンス番号リスト サーバインスタンス番号でフィルタリングして検索できる serverInstanceNoは、getServerInstanceListアクションを通じて取得可能 ex) serverInstanceNoList.1=1234&serverInstanceNoList.2=2345 | |
| serverName | No | String | - サーバ名 サーバ名でフィルタリングして検索可能 | |
| serverInstanceStatusCode | No | String | サーバインスタンスのステータスコード サーバインスタンスのステータスコードでフィルタリングして検索できる Options : INIT | CREAT | RUN | NSTOP | |
| baseBlockStorageDiskTypeCode | No | String | - 基本ブロックストレージディスクのタイプコード サーバインスタンスの基本ブロックストレージタイプでフィルタリングして検索できる Options : NET (NETWORK DISK) | |
| baseBlockStorageDiskDetailTypeCode | No | String | - 基本ブロックストレージディスクの詳細タイプコード サーバインスタンスの基本ブロックストレージの詳細タイプでフィルタリングして検索できる Options : HDD | SSD | |
| ip | No | String | - IPアドレス サーバインスタンスの IPアドレスでフィルタリングして検索できる プライベート IPアドレスやグローバル IPアドレスすべてがフィルタリングの対象となる | |
| placementGroupNoList.N | No | List<String> | -物理配置グループ番号リスト サーバインスタンスが所属される物理配置グループ番号でフィルタリングして検索できる placementGroupNoは、getPlacementGroupListアクションを通じて取得可能 ex) placementGroupNoList.1=1234&placementGroupNoList.2=2345 | |
| hypervisorTypeCodeList.N | No | List<String> | - ハイパーバイザータイプコードリスト ハイパーバイザータイプでフィルタリングし検索できる Options : XEN | KVM ex) hypervisorTypeCodeList.1=KVM&hypervisorTypeCodeList.2=XEN | |
| pageNo | No | Integer | - ページングされた結果のページ番号 結果値を pageNo、pageSizeを利用してページング処理できる | |
| pageSize | Conditional | Integer | - ページングの際に表示する各ページのサイズ 結果値を pageNo、pageSizeを利用してページング処理できる pageNoを入力する際に必ず入力する | |
| sortedBy | No | String | - ソート対象 結果値をサーバ名、サーバインスタンス番号でソートできる Options : serverName | serverInstanceNo | |
| sortingOrder | No | String | - ソート順序 sortedByの利用時、昇順/降順ソートを設定する Options: ASC (昇順) | DESC (降順) Default : ASC | |
| responseFormatType | No | String | - レスポンス結果のフォーマットタイプ Options : xml | json Default : xml |
レスポンス
レスポンスボディ
例
リクエスト例
GET {API_URL}/getServerInstanceList
?regionCode=KR
&vpcNo=***04
&serverInstanceNoList.1=***4299
&serverName=test-***
&serverInstanceStatusCode=RUN
&baseBlockStorageDiskTypeCode=NET
&baseBlockStorageDiskDetailTypeCode=SSD
&ip=***.***.111.215
&placementGroupNoList.1=***61
レスポンス例
<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>
</serverInstance>
</serverInstanceList>
</getServerInstanceListResponse>
この記事は役に立ちましたか?