---
title: "getCloudMssqlInstanceDetail"
slug: "database-vmssql-getcloudmssqlinstancedetail"
tags: ["Cloud DB for MSSQL"]
updated: 2026-10-22T10:47:20Z
published: 2026-10-22T10:47:20Z
canonical: "api-gov.ncloud-docs.com/database-vmssql-getcloudmssqlinstancedetail"
---

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

# getCloudMssqlInstanceDetail

VPC 환경에서 이용 가능합니다.

Cloud DB for MSSQL 인스턴스의 상세 정보를 조회합니다.

## 요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| --- | --- |
| GET \| POST | /vmssql/v2/getCloudMssqlInstanceDetail |

              참고

              

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

### 요청 헤더

Cloud DB for MSSQL (VPC) API에서 공통으로 사용하는 헤더에 대한 정보는 [Cloud DB for MSSQL (VPC) 요청 헤더](/docs/database-vmssql#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 쿼리 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 조회할 Cloud DB for MSSQL 인스턴스의 리전 코드 - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 - `getRegionList` 조회 결과의 첫 번째 리전(기본값) |
| `cloudMssqlInstanceNo` | String | Required | Cloud DB for MSSQL 인스턴스 번호 - [getCloudMssqlInstanceList](/docs/database-vmssql-getcloudmssqlinstancelist) 참조 가능 |
| `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` |

### 요청 예시

요청 예시는 다음과 같습니다.

```
curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vmssql/v2/getCloudMssqlInstanceDetail
?regionCode=KR
&cloudMssqlInstanceNo=2522****
&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}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

응답 바디는 [CloudMssqlInstanceList](/docs/common-vapidatatype-cloudmssqlinstancelist)를 참조해 주십시오.

### 응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/api-call-lgc-errorhandling)를 참조해 주십시오.

### 응답 예시

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

- `responseFormatType=json` 일 때

```
{
    "getCloudMssqlInstanceDetailResponse": {
        "totalRows": 1,
        "cloudMssqlInstanceList": [
            {
                "cloudMssqlInstanceNo": "2522****",
                "cloudMssqlServiceName": "mssql004",
                "cloudMssqlInstanceStatusName": "running",
                "cloudMssqlInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Created State"
                },
                "cloudMssqlInstanceOperation": {
                    "code": "NULL",
                    "codeName": "CLOUD DATABASE(VPC) Null OP"
                },
                "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043553.EE.B100",
                "isHa": true,
                "isMultiZone": false,
                "license": {
                    "code": "SPLA",
                    "codeName": "Service Provider License Agreement"
                },
                "cloudMssqlPort": 1433,
                "backupFileRetentionPeriod": 1,
                "backupTime": "08:00",
                "configGroupNo": "0",
                "configGroupName": "mssql_2019_default",
                "engineVersion": "MSSQL 15.0.4355.3 Enterprise Edition",
                "createDate": "2024-07-01T14:29:18+0900",
                "dbCollation": "Korean_Wansung_CI_AS",
                "cloudMssqlServerInstanceList": [
                    {
                        "cloudMssqlServerInstanceNo": "2528****",
                        "cloudMssqlServerName": "m-2522****-001",
                        "cloudMssqlServerRole": {
                            "code": "M",
                            "codeName": "Principal"
                        },
                        "cloudMssqlServerInstanceStatusName": "running",
                        "cloudMssqlServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudMssqlServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "59***",
                        "subnetNo": "140***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 2,
                        "memorySize": 4294967296,
                        "isPublicSubnet": true,
                        "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
                        "privateDomain": "mssql-****.vpc-cdb.ntruss.com",
                        "createDate": "2024-07-01T14:29:18+0900",
                        "uptime": "2024-07-01T14:55:41+0900",
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "usedDataStorageSize": 1073741824
                    },
                    {
                        "cloudMssqlServerInstanceNo": "2528****",
                        "cloudMssqlServerName": "m-2522****-002",
                        "cloudMssqlServerRole": {
                            "code": "H",
                            "codeName": "Mirror"
                        },
                        "cloudMssqlServerInstanceStatusName": "running",
                        "cloudMssqlServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudMssqlServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "59***",
                        "subnetNo": "140***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 2,
                        "memorySize": 4294967296,
                        "isPublicSubnet": true,
                        "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
                        "privateDomain": "mssql-****.vpc-cdb.ntruss.com",
                        "createDate": "2024-07-01T14:29:18+0900",
                        "uptime": "2024-07-01T15:08:09+0900",
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "usedDataStorageSize": 1073741824
                    },
                    {
                        "cloudMssqlServerInstanceNo": "2529****",
                        "cloudMssqlServerName": "m-2522****-003",
                        "cloudMssqlServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudMssqlServerInstanceStatusName": "running",
                        "cloudMssqlServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudMssqlServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "59***",
                        "subnetNo": "140***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 2,
                        "memorySize": 4294967296,
                        "isPublicSubnet": true,
                        "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
                        "privateDomain": "mssql-****-r001.vpc-cdb.ntruss.com",
                        "createDate": "2024-07-01T15:48:28+0900",
                        "uptime": "2024-07-01T16:16:00+0900",
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "usedDataStorageSize": 1073741824
                    }
                ],
                "accessControlGroupNoList": [
                    "186***"
                ]
            }
        ],
        "requestId": "7bcf4935-****-****-****-00e1ece53ab0",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
```
- `responseFormatType=xml` (기본값) 일 때

```
<?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlInstanceDetailResponse>
    <requestId>7bcf4935-****-****-****-00e1ece53ab0</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <cloudMssqlInstance>
            <cloudMssqlInstanceNo>2522****</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>mssql004</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>
            <cloudMssqlImageProductCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043553.EE.B100</cloudMssqlImageProductCode>
            <isHa>true</isHa>
            <isMultiZone>false</isMultiZone>
            <license>
                <code>SPLA</code>
                <codeName>Service Provider License Agreement</codeName>
            </license>
            <cloudMssqlPort>1433</cloudMssqlPort>
            <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
            <backupTime>08:00</backupTime>
            <configGroupNo>0</configGroupNo>
            <configGroupName>mssql_2019_default</configGroupName>
            <engineVersion>MSSQL 15.0.4355.3 Enterprise Edition</engineVersion>
            <createDate>2024-07-01T14:29:18+0900</createDate>
            <dbCollation>Korean_Wansung_CI_AS</dbCollation>
            <cloudMssqlServerInstanceList>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerInstanceNo>2528****</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-2522****-001</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>M</code>
                        <codeName>Principal</codeName>
                    </cloudMssqlServerRole>
                    <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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>59***</vpcNo>
                    <subnetNo>140***</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <privateDomain>mssql-****.vpc-cdb.ntruss.com</privateDomain>
                    <createDate>2024-07-01T14:29:18+0900</createDate>
                    <uptime>2024-07-01T14:55:41+0900</uptime>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <usedDataStorageSize>1073741824</usedDataStorageSize>
                </cloudMssqlServerInstance>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerInstanceNo>2528****</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-2522****-002</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>H</code>
                        <codeName>Mirror</codeName>
                    </cloudMssqlServerRole>
                    <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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>59***</vpcNo>
                    <subnetNo>140***</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <privateDomain>mssql-****.vpc-cdb.ntruss.com</privateDomain>
                    <createDate>2024-07-01T14:29:18+0900</createDate>
                    <uptime>2024-07-01T15:08:09+0900</uptime>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <usedDataStorageSize>1073741824</usedDataStorageSize>
                </cloudMssqlServerInstance>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-2522****-003</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudMssqlServerRole>
                    <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>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>59***</vpcNo>
                    <subnetNo>140***</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <privateDomain>mssql-****-r001.vpc-cdb.ntruss.com</privateDomain>
                    <createDate>2024-07-01T15:48:28+0900</createDate>
                    <uptime>2024-07-01T16:16:00+0900</uptime>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <usedDataStorageSize>1073741824</usedDataStorageSize>
                </cloudMssqlServerInstance>
            </cloudMssqlServerInstanceList>
            <accessControlGroupNoList>
                <accessControlGroupNo>186***</accessControlGroupNo>
            </accessControlGroupNoList>
        </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</getCloudMssqlInstanceDetailResponse>
```