getCloudMssqlInstanceDetail

Available in VPC

Get Cloud DB for MSSQL instance details.

Syntax

The getCloudMssqlInstanceDetail syntax is as follows:

./ncloud vmssql getCloudMssqlInstanceDetail \
    --cloudMssqlInstanceNo <instance-no> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMssqlInstanceDetail.

Required options

The following options are required for getCloudMssqlInstanceDetail.

Common options

For information about the options common to all vmssql subcommands, see Cloud DB for MSSQL (VPC) options.

Examples

If the request to retrieve detailed information about a Cloud DB for MSSQL instance is successful, the instance's configuration information and details for each server instance are returned.

Command

The command example is as follows:

./ncloud vmssql getCloudMssqlInstanceDetail \
    --cloudMssqlInstanceNo 25280088 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMssqlInstanceDetailResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "25280088",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "generationCode": "G2",
        "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15044401.SE.B100",
        "isHa": true,
        "isMultiZone": false,
        "license": {
          "code": "SPLA",
          "codeName": "License code - CLOUD DATABASE (VPC)"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 1,
        "backupTime": "09:00",
        "configGroupNo": "0",
        "configGroupName": "mssql_2019_default",
        "engineVersion": "MSSQL 15.0.4440.1 Standard Edition",
        "createDate": "2026-06-09T19:47:07+0900",
        "dbCollation": "Korean_Wansung_CI_AS",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "25280089",
            "cloudMssqlServerName": "m-25280088-001",
            "cloudMssqlServerRole": {
              "code": "M",
              "codeName": "Principal"
            },
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "isPublicSubnet": false,
            "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
            "privateDomain": "mssql-1a2b3c.vpc-cdb.ntruss.com",
            "createDate": "2026-06-09T19:47:07+0900",
            "uptime": "2026-06-09T20:16:13+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "usedDataStorageSize": 1073741824
          },
          {
            "cloudMssqlServerInstanceNo": "25280090",
            "cloudMssqlServerName": "m-25280088-002",
            "cloudMssqlServerRole": {
              "code": "H",
              "codeName": "Mirror"
            },
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "isPublicSubnet": false,
            "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
            "privateDomain": "mssql-1a2b3c.vpc-cdb.ntruss.com",
            "createDate": "2026-06-09T19:47:07+0900",
            "uptime": "2026-06-09T20:26:04+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          }
        ],
        "accessControlGroupNoList": [
          "67890123"
        ]
      }
    ],
    "requestId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}