---
title: "CloudMssqlInstance"
slug: "common-vapidatatype-cloudmssqlinstance"
tags: ["VPC", "Cloud DB for MSSQL"]
updated: 2026-09-17T09:25:09Z
published: 2026-09-17T09:25:09Z
canonical: "api.ncloud-docs.com/common-vapidatatype-cloudmssqlinstance"
---

> ## 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.

# CloudMssqlInstance

Available in VPC

This is a Cloud DB for MSSQL instance.

## Syntax

The syntax is as follows.

```
private String cloudMssqlInstanceNo;
private String cloudMssqlServiceName;
private String cloudMssqlInstanceStatusName;
private CommonCode cloudMssqlInstanceStatus;
private CommonCode cloudMssqlInstanceOperation;
private String cloudMssqlImageProductCode;
private Boolean isHa;
private Boolean isMultiZone;
private CommonCode license;
private Integer cloudMssqlPort;
private Integer backupFileRetentionPeriod;
private String backupTime;
private String configGroupNo;
private String configGroupName;
private String engineVersion;
private Date createDate;
private String dbCollation;
private List<CloudMssqlServerInstance> cloudMssqlServerInstanceList;
private List<String> accessControlGroupNoList;
```

## Field

The following describes the fields.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cloudMssqlInstanceNo` | String | Required | Cloud DB for MSSQL instance number |
| `cloudMssqlServiceName` | String | Required | Cloud DB for MSSQL service name |
| `cloudMssqlInstanceStatusName` | String | Required | Cloud DB for MSSQL instance status name - `creating` \| `deleted` \| `deleting` \| `downgrading` \| `pending` \| `recovering` \| `reinstalling` \| `restarting` \| `running` \| `settingup` \| `shuttingdown` \| `stopped` \| `upgrading` |
| `cloudMssqlInstanceStatus` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for MSSQL instance status - `INIT` \| `CREAT` \| `DEL` - `INIT`: initiated - `CREAT`: created - `DEL`: deleted |
| `cloudMssqlInstanceOperation` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Required | Cloud DB for MSSQL instance operation status - `CREAT` \| `DEL` \| `FO` \| `NULL` \| `SETUP` \| `UPGD` \| `DWGD` \| `BKP` \| `FW` - `CREAT`: Create - `DEL`: Delete - `FO`: Failover - `NULL`: No Operation - `SETUP`: Setup - `UPGD`: Upgrade - `DWGD`: Downgrade - `BKP`: Backup - `FW`: Failover Waiting |
| `cloudMssqlImageProductCode` | String | Optional | Cloud DB for MSSQL image product code |
| `isHa` | Boolean | Required | High availability status - `true` \| `false` |
| `isMultiZone` | Boolean | Required | Multi-zone status - `true` \| `false` |
| `license` | [CommonCode](/docs/en/common-vapidatatype-commoncode) | Optional | Cloud DB for MSSQL license |
| `cloudMssqlPort` | Integer | Optional | Cloud DB for MSSQL port |
| `backupFileRetentionPeriod` | Integer | Optional | Backup file retention period |
| `backupTime` | String | Optional | Backup time |
| `configGroupNo` | String | Optional | Cloud DB for MSSQL config group number |
| `configGroupName` | String | Optional | Cloud DB for MSSQL config group name |
| `engineVersion` | String | Optional | Cloud DB for MSSQL engine version |
| `createDate` | Date | Optional | Creation date and time |
| `dbCollation` | String | Optional | Cloud DB for MSSQL character set |
| `cloudMssqlServerInstanceList` | List<[CloudMssqlServerInstance](/docs/en/common-vapidatatype-cloudmssqlserverinstance)> | Required | Cloud DB for MSSQL server instance list |
| `accessControlGroupNoList` | [AccessControlGroupNoList](/docs/en/common-vapidatatype-accesscontrolgroupnolist) | Optional | ACG number list |