Documentation Index

Fetch the complete documentation index at: https://cli-fin.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createCloudMssqlInstance

Prev Next

Cloud DB for MSSQL 인스턴스를 생성합니다.

구문

createCloudMssqlInstance 구문은 다음과 같습니다.

./ncloud vmssql createCloudMssqlInstance \
    --vpcNo <vpc-no> \
    --subnetNo <subnet-no> \
    --cloudMssqlServiceName <service-name> \
    --cloudMssqlUserName <user-name> \
    --cloudMssqlUserPassword <user-password> \
    --isHa <true|false> \
    [--isMultiZone <true|false>] \
    [--mirrorSubnetNo <mirror-subnet-no>] \
    [--configGroupNo <config-group-no>] \
    [--cloudMssqlImageProductCode <image-product-code>] \
    [--cloudMssqlProductCode <product-code>] \
    [--engineVersionCode <engine-version-code>] \
    [--dataStorageTypeCode <SSD|HDD>] \
    [--characterSetName <character-set-name>] \
    [--isAutomaticBackup <true|false>] \
    [--backupTime <hh:mm>] \
    [--backupFileRetentionPeriod <retention-days>] \
    [--cloudMssqlPort <port>] \
    [--regionCode <FKR>] \
    [--output <json|xml>]

옵션

createCloudMssqlInstance 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

createCloudMssqlInstance의 필수 옵션입니다.

옵션 타입 필수 여부 설명
--vpcNo String Required Cloud DB for MSSQL 인스턴스를 생성할 VPC 번호
--subnetNo String Required Cloud DB for MSSQL 인스턴스에서 사용할 기본 네트워크 인터페이스의 Subnet 번호
  • Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청 가능
  • Cloud DB for MSSQL 인스턴스 생성 이후 Subnet 이전 불가
  • getCloudMssqlTargetSubnetList 참조
--cloudMssqlServiceName String Required Cloud DB for MSSQL 서비스 이름
  • 영문자, 한글, 숫자, 특수문자 -를 조합하여 3~15자 이내로 입력
--cloudMssqlUserName String Required DB User ID
  • 영문자, 숫자, 특수문자 _를 조합하여 4~16자 이내로 입력
  • 문자열은 영문자로 시작
--cloudMssqlUserPassword String Required DB User 비밀번호
  • 영어/특수문자/숫자 3개 항목에 대해 1자 이상 포함하여 8~20자 이내로 입력
  • 특수문자 ` & \ " ' / 및 공백 사용 불가
--isHa Boolean Required 고가용성 여부
  • true (기본값) | false
    • true: Mirror 서버를 포함한 2대의 서버로 생성되며 추가 요금 발생
    • false: isMultiZone, mirrorSubnetNo 사용 불가
--mirrorSubnetNo String Conditional Mirror 서버의 Subnet 번호
  • Cloud DB for MSSQL이 멀티존인 경우, 필수 입력
  • Principal 서버의 Subnet과 존이 다르고, Public 또는 Private는 같아야 함
  • getCloudMssqlTargetSubnetList 참조
--backupTime String Conditional 백업 시점 설정 (HH:MM)
  • isAutomaticBackup=false인 경우, 필수 입력
  • 15분 단위로 입력 가능
  • 예시: 01:15

선택 옵션

createCloudMssqlInstance의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션 타입 필수 여부 설명
--isMultiZone Boolean Optional 멀티존 여부
  • true | false (기본값)
    • true: Principal 서버와 Mirror 서버를 서로 다른 존에 생성하여 더욱 높은 가용성 제공
    • false: 멀티존 사용 안 함
  • isHa=true인 경우에만 사용 가능
--configGroupNo String Optional Cloud DB for MSSQL Config Group 번호
  • 기본값: 0
  • 사전에 생성한 Config Group을 서버 생성 시 적용 가능
  • 별도의 Config Group이 없는 경우, 기본 제공되는 Config Group 중 선택 가능
  • getCloudMssqlConfigGroupList 참조
--cloudMssqlImageProductCode String Optional Cloud DB for MSSQL 이미지 상품 코드
--cloudMssqlProductCode String Optional Cloud DB for MSSQL 상품 코드
  • Cloud DB for MSSQL 인스턴스의 서버 스펙 결정
  • 기본값: 최소 사양 (메모리, CPU 순)
  • getCloudMssqlProductList 참조
--engineVersionCode String Optional DB 엔진 버전
--dataStorageTypeCode String Optional 데이터 스토리지 타입 코드
  • SSD (기본값) | HDD
  • 설치 이후 데이터 스토리지 타입 변경 불가
--characterSetName String Optional DB 문자셋
--isAutomaticBackup Boolean Optional 백업 시점 자동 설정 여부
  • true (기본값) | false
  • true인 경우, backupTime 입력 불가
--backupFileRetentionPeriod Integer Optional 백업 파일 보관 기간 (일)
  • 1~`30(기본값:1`)
  • 백업은 매일 수행되며, 백업 파일은 별도의 스토리지에 저장
  • 요금은 사용하는 공간만큼만 과금
--cloudMssqlPort Integer Optional Cloud DB for MSSQL 인스턴스에 접근하기 위한 TCP 포트 번호
  • 10000~`20000(기본값:1433`)

공통 옵션

vmssql 명령에서 공통으로 사용하는 옵션에 대한 정보는 Cloud DB for MSSQL 옵션을 참조해 주십시오.

예시

Cloud DB for MSSQL 인스턴스 생성 요청이 성공하면 인스턴스의 구성 정보와 생성 상태가 반환됩니다.

명령

명령 예시는 다음과 같습니다.

./ncloud vmssql createCloudMssqlInstance \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudMssqlServiceName test-mssql-01 \
    --cloudMssqlUserName testuser \
    --cloudMssqlUserPassword Examplepw123! \
    --isHa true \
    --cloudMssqlImageProductCode SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15044401.SE.B100 \
    --cloudMssqlProductCode SVR.VMSSL.STAND.C002.M004.NET.HDD.B100.G001 \
    --regionCode FKR \
    --output json

출력

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

{
  "createCloudMssqlInstanceResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "141402185",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "creating",
        "cloudMssqlInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init 상태"
        },
        "cloudMssqlInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "generationCode": "G2",
        "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15044401.SE.B100",
        "isHa": true,
        "isMultiZone": false,
        "license": {
          "code": "SPLA",
          "codeName": "라이센스코드-CLOUD DATABASE(VPC)"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 1,
        "backupTime": "02:30",
        "configGroupNo": "0",
        "configGroupName": "mssql_2019_default",
        "engineVersion": "MSSQL 15.0.4440.1 Standard Edition",
        "createDate": "2026-06-18T13:12:54+0900",
        "dbCollation": "Korean_Wansung_CI_AS",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerName": "m-141402185-001",
            "cloudMssqlServerRole": {
              "code": "M",
              "codeName": "Principal"
            },
            "cloudMssqlServerInstanceStatusName": "creating",
            "cloudMssqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) 서버 Pending 상태"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) 서버 Create OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "isPublicSubnet": false,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M004.NET.HDD.B100.G001",
            "createDate": "2026-06-18T13:12:54+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMssqlServerName": "m-141402185-002",
            "cloudMssqlServerRole": {
              "code": "H",
              "codeName": "Mirror"
            },
            "cloudMssqlServerInstanceStatusName": "creating",
            "cloudMssqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) 서버 Pending 상태"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) 서버 Create OP"
            },
            "regionCode": "FKR",
            "zoneCode": "FKR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "isPublicSubnet": false,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M004.NET.HDD.B100.G001",
            "createDate": "2026-06-18T13:12:54+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          }
        ]
      }
    ],
    "requestId": "16a47b90-c79c-4db5-9f0d-a7acaa7dbaea",
    "returnCode": "0",
    "returnMessage": "success"
  }
}