---
title: "getCloudMssqlInstanceList"
slug: "cli-vmssql-getcloudmssqlinstancelist"
tags: ["Cloud DB for MSSQL", "VPC"]
updated: 2026-04-23T08:57:08Z
published: 2026-04-23T08:58:59Z
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

<p class="platform-info type-vpc">VPC 환경에서 이용 가능합니다.</p>

Cloud DB for MSSQL 인스턴스 목록을 조회합니다.

## 명령어<a name="명령어"></a>

명령어 구문은 다음과 같습니다.

```
ncloud vmssql getCloudMssqlInstanceList [cloudMssqlInstanceNoList] [cloudMssqlServiceName] [cloudMssqlServerInstanceNoList] [cloudMssqlServerName] [regionCode] [zoneCode] [vpcNo] [subnetNo] [pageNo] [pageSize] [output]
```

### 파라미터<a name="파라미터"></a>

파라미터에 대한 설명은 다음과 같습니다.

| 파라미터                       | 타입               | 필수 여부 | 설명                                                       | 제약 사항 |
| ------------------------------ | ------------------ | --------- | ---------------------------------------------------------- | --------- |
| cloudMssqlInstanceNoList       | List&lt;String&gt; | N         | Cloud DB for MSSQL 인스턴스 번호 목록<br>- Cloud DB for MSSQL 인스턴스 번호로 필터링하여 검색 가능<br>- cloudMssqlInstanceNoList는 [getCloudMssqlInstanceList](/docs/cli-vmssql-getcloudmssqlinstancelist) 액션을 통해서 획득<br>- ex) cloudMssqlInstanceNoList 1234 2345 | -         |
| cloudMssqlServiceName          | String             | N         | Cloud DB for MSSQL 서비스 이름<br>- Cloud DB for MSSQL 서비스 이름으로 필터링하여 검색 가능<br>- cloudMssqlServiceName은 [getCloudMssqlInstanceList](/docs/cli-vmssql-getcloudmssqlinstancelist) 액션을 통해서 획득 | -         |
| cloudMssqlServerInstanceNoList | List&lt;String&gt; | N         | Cloud DB for MSSQL 서버 인스턴스 번호 목록<br>- Cloud DB for MSSQL 서버 인스턴스 번호로 필터링하여 검색 가능<br>- cloudMssqlServerInstanceNoList [getCloudMssqlInstanceList](/docs/cli-vmssql-getcloudmssqlinstancelist) 액션을 통해서 획득<br>- ex) cloudMssqlServerInstanceNoList 1234 2345 | -         |
| cloudMssqlServerName           | String             | N         | Cloud DB for MSSQL 서버 이름<br>- Cloud DB for MSSQL 서버 이름으로 필터링하여 검색 가능<br>- cloudMssqlServerName은 [getCloudMssqlInstanceList](/docs/cli-vmssql-getcloudmssqlinstancelist) 액션을 통해서 획득 | -         |
| regionCode                     | String             | N         | 리전 코드<br>- regionCode는 [getRegionList](/docs/cli-vserver-server-common-getregionlist) 액션을 통해서 획득<br>- default: getRegionList 조회 결과의 첫 번째 리전을 선택 | -         |
| zoneCode                       | String             | N         | Zone 코드<br>- zoneCode는 [getZoneList](/docs/cli-vserver-server-common-getzonelist) 액션을 통해서 획득 | -         |
| vpcNo                          | String             | N         | VPC 번호<br>- vpcNo는 [getCloudMssqlTargetVpcList](/docs/cli-vmssql-getcloudmssqltargetvpclist) 액션을 통해서 획득 | -         |
| subnetNo                       | String             | N         | Subnet 번호<br>- SubnetNo는 [getCloudMssqlTargetSubnetList](/docs/cli-vmssql-getcloudmssqltargetsubnetlist) 액션을 통해서 획득 | -         |
| pageNo                         | Integer            | N         | 페이징 된 결과의 페이지 번호<br>- 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 | - Min: 0  |
| pageSize                       | Integer            | N         | 페이징 시 보여줄 각 페이지 사이즈<br>- 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능<br>- pageNo 입력시 반드시 입력 | - Min: 1  |
| output                         | String             | N         | 응답 결과의 포맷 타입<br>- options: xml \| json<br>- default: json | - |

## 응답<a name="응답"></a>

### 응답 데이터 타입<a name="응답데이터타입"></a>

- CloudMssqlInstanceList 타입

    | CloudMssqlInstanceList extends CommonResponse                | 설명                             |
    | ------------------------------------------------------------ | -------------------------------- |
    | private Integer totalRows;                                   | 조회된 목록의 총 개수            |
    | private List&lt;CloudMssqlInstance&gt; cloudMssqlInstanceList = new ArrayList&lt;&gt;(); | Cloud DB for MSSQL 인스턴스 목록 |

- CloudMssqlInstance 타입

    | CloudMssqlInstance                                           | 설명                                                         |
    | ------------------------------------------------------------ | ------------------------------------------------------------ |
    | private String cloudMssqlInstanceNo;                         | Cloud DB for MSSQL 인스턴스 번호                             |
    | private String cloudMssqlServiceName;                        | Cloud DB for MSSQL 서비스 이름                               |
    | private String cloudMssqlInstanceStatusName;                 | Cloud DB for MSSQL 인스턴스 상태 이름<br>- `creating`<br>- `deleted`<br>- `deleting`<br>- `downgrading`<br>- `pending`<br>- `recovering`<br>- `reinstalling`<br>- `restarting`<br>- `running`<br>- `settingup`<br>- `shuttingdown`<br>- `stopped`<br>- `upgrading` |
    | private CommonCode cloudMssqlInstanceStatus;                 | Cloud DB for MSSQL 인스턴스 상태 코드<br>- `INIT (initiate)`<br>- `CREAT (created)`<br>- `DEL (deleted)` |
    | private CommonCode cloudMssqlInstanceOperation;              | Cloud DB for MSSQL 인스턴스 Operation 코드<br>- `CREAT (create)` <br>- `DEL (delete)` <br>- `FO (failover)` <br>- `NULL (no operation)` <br>- `SETUP (setup)` <br>- `UPGD (upgrade)`<br>- `DWGD (downgrade)`<br>- `BKP (backup)` <br>- `FW (Failover waiting)`|
    | private String cloudMssqlImageProductCode;                   | Cloud DB for MSSQL 이미지 상품 코드                          |
    | private Boolean isHa;                                        | 고가용성 여부                                                |
    | private Boolean isMultiZone;                                 | 멀티존 여부                                                  |
    | private CommonCode license;                                  | Cloud DB for MSSQL 라이선스                                  |
    | private Integer cloudMssqlPort;                              | Cloud DB for MSSQL 포트                                      |
    | private Integer backupFileRetentionPeriod;                   | 백업 파일 보관 기간                                          |
    | private String backupTime;                                   | 백업 시간                                                    |
    | private String configGroupNo;                                | Cloud DB for MSSQL Config Group 번호                         |
    | private String configGroupName;                              | Cloud DB for MSSQL Config Group 이름                         |
    | private String engineVersion;                                | Cloud DB for MSSQL 엔진 버전                                 |
    | private Date createDate;                                     | 생성일자                                                     |
    | private String dbCollation;                                  | Cloud DB for MSSQL 문자셋                                    |
    | private List&lt;CloudMssqlServerInstance&gt; cloudMssqlServerInstanceList; | Cloud DB for MSSQL 서버 인스턴스 목록                        |
    | private AccessControlGroupNoList accessControlGroupNoList;   | ACG 번호 목록                                                |

- CloudMssqlServerInstance 타입

    | CloudMssqlServerInstance                              | 설명                                                         |
    | ----------------------------------------------------- | ------------------------------------------------------------ |
    | private String cloudMssqlServerInstanceNo;            | Cloud DB for MSSQL 서버 인스턴스 번호                        |
    | private String cloudMssqlServerName;                  | Cloud DB for MSSQL 서버 이름                                 |
    | private CommonCode cloudMssqlServerRole;              | Cloud DB for MSSQL 서버 역할                                 |
    | private String cloudMssqlServerInstanceStatusName;    | Cloud DB for MSSQL 서버 인스턴스 상태 이름<br>- `creating`<br>- `deleted`<br>- `deleting`<br>- `downgrading`<br>- `pending`<br>- `recovering`<br>- `reinstalling`<br>- `restarting`<br>- `running`<br>- `settingup`<br>- `shuttingdown`<br>- `stopped`<br>- `upgrading`<br>- `downgrading` |
    | private CommonCode cloudMssqlServerInstanceStatus;    | Cloud DB for MSSQL 서버 인스턴스 상태 코드<br>- `DEL (deleted)`<br>- `PEND (pending)`<br>- `RUN (running)`<br>- `STOP (stopped)`<br>- `FSTOP (failure stopped)` |
    | private CommonCode cloudMssqlServerInstanceOperation; | Cloud DB for MSSQL 서버 인스턴스 Operation 코드<br>- `NOOP (no operation)`<br>- `CREAT (create)`<br>- `START (start)`<br>- `RSTRT (restart)`<br>- `SETUP (setup)`<br>- `STOP (stop)`<br>- `FO (failover)`<br>- `DEL (delete)`<br>- `UPGD (upgrade)`<br>- `DWGD (downgrade)`<br>- `RISTL (reinstall)`|
    | private String regionCode;                            | 리전 코드                                                    |
    | private String zoneCode;                              | Zone 코드                                                    |
    | private String vpcNo;                                 | VPC 번호                                                     |
    | private String subnetNo;                              | Subnet 번호                                                  |
    | private Long dataStorageSize;                         | 데이터 스토리지 사이즈                                       |
    | private Integer cpuCount;                             | CPU 개수                                                     |
    | private Long memorySize;                              | 메모리 사이즈                                                |
    | private Boolean isPublicSubnet;                       | Public Subnet 여부                                           |
    | private String cloudMssqlProductCode;                 | Cloud DB for MSSQL 상품 코드                                 |
    | private String privateDomain;                         | 사설 도메인명                                                |
    | private String publicDomain;                          | 공인 도메인명                                                |
    | private Date createDate;                              | 생성일자                                                     |
    | private Date uptime;                                  | VM 부팅 완료 시간                                            |
    | private CommonCode dataStorageType;                   | 데이터 스토리지 타입                                         |
    | private Long usedDataStorageSize;                     | 사용중인 데이터 스토리지 사이즈                              |

- AccessControlGroupNoList 타입

    | AccessControlGroupNoList                                     | 설명          |
    | ------------------------------------------------------------ | ------------- |
    | private List&lt;String&gt; accessControlGroupNoList = new ArrayList<>(); | ACG 번호 목록 |

## 예시<a name="예시"></a>

호출과 응답 예시를 설명합니다.

### 호출 예시<a name="호출예시"></a>

호출 예시는 다음과 같습니다.


```http
ncloud vmssql getCloudMssqlInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***83 --subnetNo **91 --cloudMssqlServiceName test-**** --cloudMssqlInstanceNoList ****890 --cloudMssqlServerName test--**** --cloudMssqlServerInstanceNoList ****891 --pageNo 0 --pageSize 10
```

### 응답 예시<a name="응답예시"></a>

응답 예시는 다음과 같습니다.

#### 응답 결과 포맷 타입(output)이 json인 경우<a name="응답결과포맷타입output이json인경우"></a>

응답 결과 포맷 타입(output)이 json인 경우는 다음과 같습니다.

```json
{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "*****90",
        "cloudMssqlServiceName": "******",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "******91",
            "cloudMssqlServerName": "*******001",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          },
          {
            "cloudMssqlServerInstanceNo": "********",
            "cloudMssqlServerName": "*********002",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          }
        ]
      }
    ],
    "requestId": "*********************************",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
```

#### 응답 결과 포맷 타입(responseFormatType)이 xml인 경우<a name="응답결과포맷타입responseFormatType이xml인경우"></a>

응답 결과 포맷 타입(responseFormatType)이 xml인 경우는 다음과 같습니다.

```xml
<getCloudMssqlInstanceListResponse>
    <requestId>*********************************</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
      <cloudMssqlInstance>
        <cloudMssqlInstanceNo>*******</cloudMssqlInstanceNo>
        <cloudMssqlServiceName>*******</cloudMssqlServiceName>
        <cloudMssqlInstanceStatusName>running</cloudMssqlInstanceStatusName>
        <cloudMssqlInstanceStatus>
          <code>CREAT</code>
          <codeName>CLOUD DATABASE(VPC) Created State</codeName>
        </cloudMssqlInstanceStatus>
        <cloudMssqlInstanceOperation>
          <code>NULL</code>
          <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
        </cloudMssqlInstanceOperation>
        <cloudMssqlServerInstanceList>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>*******</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>*******</cloudMssqlServerName>
            <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName>
            <cloudMssqlServerInstanceStatus>
              <code>RUN</code>
              <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
            </cloudMssqlServerInstanceStatus>
            <cloudMssqlServerInstanceOperation>
              <code>NOOP</code>
              <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
            </cloudMssqlServerInstanceOperation>
            <vpcNo>*****</vpcNo>
            <subnetNo>*****</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>********</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>********</cloudMssqlServerName>
            <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName>
            <cloudMssqlServerInstanceStatus>
              <code>RUN</code>
              <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
            </cloudMssqlServerInstanceStatus>
            <cloudMssqlServerInstanceOperation>
              <code>NOOP</code>
              <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
            </cloudMssqlServerInstanceOperation>
            <vpcNo>*****</vpcNo>
            <subnetNo>******</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
        </cloudMssqlServerInstanceList>
      </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</getCloudMssqlInstanceListResponse>
```