--- title: "getServerInstanceList" slug: "compute-vserver-server-getserverinstancelist" updated: 2026-09-17T09:57:39Z published: 2026-09-17T09:57:39Z canonical: "api.ncloud-docs.com/compute-vserver-server-getserverinstancelist" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # getServerInstanceList VPC環境で利用できます。 サーバインスタンス(VM)リストを照会します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET \| POST | /vserver/v2/getServerInstanceList | 参考 ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。 ### リクエストヘッダ Server APIで共通して使用されるヘッダの詳細は、[Serverのリクエストヘッダ](/docs/ja/compute-vserver#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `regionCode` | String | Optional | リージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - 照会結果の最初のリージョン(デフォルト) | | `vpcNo` | String | Optional | VPC番号で絞り込み - [getVpcList](/docs/ja/networking-vpc-vpcmanagement-getvpclist)を参照 | | `serverInstanceNoList.N` | Array | Optional | サーバインスタン番号リスト - サーバインスタンス番号で絞り込み - [getServerInstanceList](/docs/ja/compute-vserver-server-getserverinstancelist)を参照 - <例> `serverInstanceNoList.1=1234&serverInstanceNoList.2=2345` | | `serverName` | String | Optional | サーバ名で絞り込み | | `serverInstanceStatusCode` | String | Optional | サーバイメージの状態コードで絞り込み - `INIT` \| `CREAT` \| `RUN` \| `NSTOP` | | `baseBlockStorageDiskTypeCode` | String | Optional | 基本ブロックストレージのディスクタイプコードで絞り込み - `NET`: ネットワークディスク (有効値) | | `baseBlockStorageDiskDetailTypeCode` | String | Optional | 基本ブロックストレージのディスクの詳細タイプコードで絞り込み - `HDD` \| `SSD` | | `ip` | String | Optional | サーバの IPアドレスで絞り込み - プライベート IPアドレスとパブリック IPアドレスのいずれも対象 | | `placementGroupNoList.N` | Array | Optional | 物理配置グループ番号リスト - サーバインスタンスが属する物理配置グループ番号で絞り込み - [getPlacementGroupList](/docs/ja/compute-vserver-server-placementgroup-getplacementgrouplist)を参照 - <例> `placementGroupNoList.1=1234&placementGroupNoList.2=2345` | | `hypervisorTypeCodeList.N` | Array | Optional | ハイパーバイザタイプコードリスト - `XEN` \| `KVM` - ハイパーバイザタイプコードで絞り込み - <例> `hypervisorTypeCodeList.1=KVM&hypervisorTypeCodeList.2=XEN` | | `fabricClusterPoolNo` | String | Optional | Fabric Cluster Pool番号で絞り込み - [getFabricClusterPoolList](/docs/ja/compute-vserver-fabriccluster-getfabricclusterpoollist)を参照 | | `fabricClusterNo` | String | Optional | Fabric Cluster番号で絞り込み - [getFabricClusterList](/docs/ja/compute-vserver-fabriccluster-getfabricclusterlist)を参照 | | `fabricClusterMode` | String | Optional | Fabric Clusterモードで絞り込み - `SINGLE` \| `CLUSTER` - `SINGLE`: Fabric Clusterに含まれていないサーバ - `CLUSTER`: Fabric Clusterに含まれているサーバ | | `pageNo` | Integer | Optional | ページ番号 - 0~N (デフォルト: 0) - 最初のページ: `0`または`1`を入力 | | `pageSize` | Integer | Conditional | ページごとの項目数 - 1~1000 (デフォルト: 1) - `pageNo`入力時、必ず入力 | | `sortedBy` | String | Optional | ソートの基準 - `serverName` \| `serverInstanceNo` - `serverName`: サーバ名 - `serverInstanceNo`: サーバインスタンス番号 | | `sortingOrder` | String | Optional | ソート順序 - `ASC` (デフォルト) \| `DESC` - `ASC`: 昇順 - `DESC`: 降順 | | `responseFormatType` | String | Optional | レスポンスデータの形式 - `xml`(デフォルト) \| `json` | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerInstanceList ?regionCode=KR &vpcNo=***** &serverInstanceNoList.1=*****8773 &serverName=test-*** &serverInstanceStatusCode=RUN &baseBlockStorageDiskTypeCode=NET &baseBlockStorageDiskDetailTypeCode=SSD &ip=221.188.***.*** &placementGroupNoList.1=***45 &responseFormatType=json' \ --header 'x-ncp-apigw-timestamp: {Timestamp}' \ --header 'x-ncp-iam-access-key: {Access Key}' \ --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `getServerInstanceListResponse` | Object | - | レスポンス結果 - [ServerInstanceList](/docs/ja/common-vapidatatype-serverinstancelist)を参照 | | `getServerInstanceListResponse.requestId` | String | - | リクエスト ID - UUID形式 | | `getServerInstanceListResponse.returnCode` | String | - | レスポンスコード | | `getServerInstanceListResponse.returnMessage` | String | - | レスポンスメッセージ | ### レスポンスステータスコード Server APIで共通して使用されるレスポンスステータスコードの詳細は、[Serverのレスポンスステータスコード](/docs/ja/compute-vserver#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 #### Serverの場合 ``` { "getServerInstanceListResponse": { "totalRows": 1, "serverInstanceList": [ { "serverInstanceNo": "*****8773", "serverName": "test-***", "serverDescription": "", "cpuCount": 4, "memorySize": 8589934592, "platformType": { "code": "UBD64", "codeName": "Ubuntu Desktop 64 Bit" }, "loginKeyName": "test-***", "publicIpInstanceNo": "*****8824", "publicIp": "211.188.***.***", "serverInstanceStatus": { "code": "RUN", "codeName": "サーバ RUN状態" }, "serverInstanceOperation": { "code": "NULL", "codeName": "サーバ NULL OP" }, "serverInstanceStatusName": "running", "createDate": "2025-06-11T17:00:14+0900", "uptime": "2025-06-19T16:49:07+0900", "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003", "serverProductCode": "SVR.VSVR.CPU.C004.M008.G003", "isProtectServerTermination": true, "zoneCode": "KR-1", "regionCode": "KR", "vpcNo": "***75", "subnetNo": "****36", "networkInterfaceNoList": [ "*****30" ], "initScriptNo": "", "serverInstanceType": { "code": "CPU", "codeName": "CPU Intensive" }, "baseBlockStorageDiskType": { "code": "NET", "codeName": "ネットワークストレージ" }, "baseBlockStorageDiskDetailType": { "code": "SSD", "codeName": "SSD" }, "placementGroupNo": "", "placementGroupName": "", "memberServerImageInstanceNo": "", "hypervisorType": { "code": "KVM", "codeName": "KVM" }, "serverImageNo": "104630229", "serverSpecCode": "ci4-g3", "eventList": [], "fabricClusterPoolNo": "", "fabricClusterPoolName": "", "fabricClusterMode": "", "fabricClusterNo": "", "fabricClusterName": "" } ], "requestId": "f116d46e-638e-43d8-9047-e48746b6e6cf", "returnCode": "0", "returnMessage": "success" } } ``` #### 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" } } ```