---
title: "getCloudMssqlInstanceList"
slug: "cli-vmssql-getcloudmssqlinstancelist"
tags: ["Cloud DB for MSSQL", "VPC"]
updated: 2026-09-17T10:11:08Z
published: 2026-09-17T10:11:08Z
canonical: "cli.ncloud-docs.com/cli-vmssql-getcloudmssqlinstancelist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getCloudMssqlInstanceList

VPC環境で利用できます。

Cloud DB for MSSQLインスタンスリストを照会します。

## 構文

`getCloudMssqlInstanceList`構文は次の通りです。

```
./ncloud vmssql getCloudMssqlInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudMssqlServiceName <service-name>] \
    [--cloudMssqlInstanceNoList <instance-no-list>] \
    [--cloudMssqlServerName <server-name>] \
    [--cloudMssqlServerInstanceNoList <server-instance-no-list>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]
```

## オプション

`getCloudMssqlInstanceList`の実行時に指定できるオプションについて説明します。

### 必須オプション

`getCloudMssqlInstanceList`の必須オプションです。

| オプション | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `--pageSize` | Integer | Conditional | ページごとの項目数 - `pageNo`入力時、必ず入力 |

### 任意オプション

`getCloudMssqlInstanceList`の任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

| オプション | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `--zoneCode` | String | Optional | ゾーンコード - [getZoneList](/docs/ja/cli-vserver-server-common-getzonelist)を参照 |
| `--vpcNo` | String | Optional | VPC番号 - [getCloudMssqlTargetVpcList](/docs/ja/cli-vmssql-getcloudmssqltargetvpclist)を参照 |
| `--subnetNo` | String | Optional | Subnet番号 - [getCloudMssqlTargetSubnetList](/docs/ja/cli-vmssql-getcloudmssqltargetsubnetlist)を参照 |
| `--cloudMssqlServiceName` | String | Optional | Cloud DB for MSSQLサービス名 |
| `--cloudMssqlInstanceNoList` | List | Optional | Cloud DB for MSSQLインスタンス番号リスト - スペースで区切って複数入力可能 (例: `--cloudMssqlInstanceNoList 1234 2345`) |
| `--cloudMssqlServerName` | String | Optional | Cloud DB for MSSQLサーバ名 |
| `--cloudMssqlServerInstanceNoList` | List | Optional | Cloud DB for MSSQLサーバインスタンス番号リスト - スペースで区切って複数入力可能 (例: `--cloudMssqlServerInstanceNoList 1234 2345`) |
| `--pageNo` | Integer | Optional | ページ番号 - `0`~N |

### 共通オプション

`vmssql`コマンドで共通して使用するオプションについては、[Cloud DB for MSSQL (VPC)のオプション](/docs/ja/cli-vmssql#%EC%98%B5%EC%85%98)を参照してください。

## 例

Cloud DB for MSSQLインスタンスリストの照会リクエストが成功すると、各インスタンスの構成情報と状態が返されます。

### コマンド

コマンドの例は次の通りです。

```
./ncloud vmssql getCloudMssqlInstanceList \
    --zoneCode KR-1 \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudMssqlServiceName test-mssql-01 \
    --cloudMssqlInstanceNoList 25280088 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json
```

### 出力

出力の例は次の通りです。

```
{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "25280088",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created状態"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "generationCode": "G2",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "25280089",
            "cloudMssqlServerName": "m-25280088-001",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
            },
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296
          },
          {
            "cloudMssqlServerInstanceNo": "25280090",
            "cloudMssqlServerName": "m-25280088-002",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC)サーバ Running状態"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
            },
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
```