createCloudMssqlInstance
    • PDF

    createCloudMssqlInstance

    • PDF

    기사 요약

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

    명령어

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

    ncloud vmssql createCloudMssqlInstance [regionCode] [vpcNo] [subnetNo] [mirrorSubnetNo] [cloudMssqlServiceName] [configGroupNo] [cloudMssqlImageProductCode] [cloudMssqlProductCode] [dataStorageTypeCode] [isHa] [isMultiZone] [backupFileRetentionPeriod] [backupTime] [isAutomaticBackup] [cloudMssqlUserName] [cloudMssqlUserPassword] [cloudMssqlPort] [characterSetName] [output]
    

    파라미터

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

    파라미터타입필수 여부설명제약 사항
    regionCodeStringN리전 코드
    - regionCode는 getRegionList 액션을 통해서 획득
    - default: getRegionList 조회 결과의 첫 번째 리전을 선택
    -
    vpcNoStringYVPC 번호
    - vpcNo는 getCloudMssqlTargetVpcList 액션을 통해서 획득
    -
    subnetNoStringYSubnet 번호
    - subnetNo는 getCloudMssqlTargetSubnetList 액션을 통해서 획득
    - Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청 가능
    - Cloud DB for MSSQL 인스턴스 생성 이후에 Subnet 이전 불가
    -
    mirrorSubnetNoStringNMirror 서버의 Subnet 번호
    - 멀티존 여부(isMultiZone)가 false이면 입력 받지 않으며 멀티존 여부(isMultiZone)가 true이면 반드시 입력
    - mirrorSubnetNo는 Principal 서버의 Subnet과 Zone이 달라야 하며 같은 Public이거나 Private이어야만 함
    - mirrorSubnetNo는 getCloudMssqlTargetSubnetList 액션을 통해서 획득
    -
    cloudMssqlServiceNameStringYCloud DB for MSSQL 서비스 이름- 영어, 숫자, 하이픈(-), 한글만 입력 가능
    - Min: 3
    - Max: 15
    configGroupNoStringNCloud DB for MSSQL Config Group 번호
    - 사전에 만들어 놓은 Config Group을 서버 생성할 때 적용
    - 별도의 Config Group이 없을 경우 기본 제공되는 것 선택
    - getCloudMssqlConfigGroupList를 통해 조회 가능
    - default: 0
    -
    cloudMssqlImageProductCodeStringNCloud DB for MSSQL 이미지 상품 코드
    - cloudMssqlImageProductCode는 getCloudMssqlImageProductList 액션의 productCode로 획득
    - 입력하지 않을 경우 Default값으로 생성
    -
    cloudMssqlProductCodeStringNCloud DB for MSSQL 상품 코드
    - 생성할 Cloud DB for MSSQL 인스턴스의 서버 스펙 결정
    - cloudMssqlProductCode는 getCloudMssqlProductList 액션의 productCode로 획득
    - default: 최소 사양으로 선택. 최소 사양의 기준은 1. 메모리 2. CPU
    -
    dataStorageTypeCodeStringN데이터 스토리지 타입 코드
    - 설치 이후에 데이터 스토리지 타입 변경은 불가
    - options: SSD or HDD
    - default: SSD
    -
    isHaBooleanY고가용성 여부
    - 고가용성 선택 시 Standby Master 서버를 포함한 2대의 서버로 생성되며 추가 요금이 발생
    - default: true
    -
    isMultiZoneBooleanN멀티존 여부
    - 고가용성 여부(isHa)가 true일 경우, 멀티존 여부 선택 가능
    - 멀티존 선택 시Principal 서버와 Mirror 서버를 서로 다른 Zone에 생성하여 더욱 높은 가용성 제공
    - 고가용성 여부(isHa)가 true일 경우 반드시 입력
    - default: false
    -
    backupFileRetentionPeriodIntegerN백업 파일 보관 기간
    - 백업은 매일 수행, 백업 파일은 별도의 백업 스토리지에 저장
    - 요금은 사용하는 공간만큼 과금
    - default: 1(1일)
    - Min: 1
    - Max: 30
    backupTimeStringN백업 시간
    - 백업이 수행되는 시간 설정. 자동 백업 여부(isAutomaticBackup)가 false이면 반드시 입력
    - 01:15
    - HHMM 형식. 15 분 단위만 입력 가능
    isAutomaticBackupBooleanN백업 시간 자동 여부
    - 자동으로 백업 시간을 설정할지에 대한 여부를 선택
    - 자동 백업 여부(isAutomaticBackup)가 true이면 backupTime이 입력되어도 무시되고 자동 설정됨
    -
    cloudMssqlUserNameStringY접근 유저명
    - DB 관리자 용도로 사용할 유저명 입력
    - 영어, 숫자, 밑줄 문자( _ )만 허용하며 영어로 시작
    - Min: 4
    - Max: 16
    cloudMssqlUserPasswordStringY접근 패스워드
    - DB 관리자 용도로 사용할 유저의 패스워드 입력
    - 8자 이상, 영어/특수문자/숫자 3개 항목에 대해 1자 이상 포함
    - ` & \ " ' / 스페이스는 패스워드로 사용 불가
    - Min: 8
    - Max: 20
    cloudMssqlPortIntegerNCloud DB for MSSQL 포트
    - MSSQL 접근을 위한 TCP 포트 번호 입력
    - default: 1433
    1433
    or
    - Min: 10000
    - Max: 20000
    characterSetNameStringNDB 문자셋
    - DB 문자셋은 한글과 영어 collation 중에서 선택 가능
    - getCloudMssqlCharacterSetList API를 통해 조회 가능
    - default: Korean_Wansung_CI_AS
    -
    outputStringN응답 결과의 포맷 타입
    - options: xml | json
    - default: json
    -

    응답

    응답 데이터 타입

    • CloudMssqlInstanceList 타입
    CloudMssqlInstanceList extends CommonResponse설명
    private Integer totalRows;조회된 목록의 총 개수
    private List<CloudMssqlInstance> cloudMssqlInstanceList = new ArrayList<>();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 인스턴스 상태 이름
    - creating
    - deleted
    - deleting
    - downgrading
    - pending
    - recovering
    - reinstalling
    - restarting
    - running
    - settingup
    - shuttingdown
    - stopped
    - upgrading
    private CommonCode cloudMssqlInstanceStatus;Cloud DB for MSSQL 인스턴스 상태 코드
    - INIT (initiate)
    - CREAT (created)
    - DEL (deleted)
    private CommonCode cloudMssqlInstanceOperation;Cloud DB for MSSQL 인스턴스 Operation 코드
    - CREAT (create)
    - DEL (delete)
    - FO (failover)
    - NULL (no operation)
    - SETUP (setup)
    - UPGD (upgrade)
    - DWGD (downgrade)
    - BKP (backup)
    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<CloudMssqlServerInstance> 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 서버 인스턴스 상태 이름
    - creating
    - deleted
    - deleting
    - downgrading
    - pending
    - recovering
    - reinstalling
    - restarting
    - running
    - settingup
    - shuttingdown
    - stopped
    - upgrading
    - downgrading
    private CommonCode cloudMssqlServerInstanceStatus;Cloud DB for MSSQL 서버 인스턴스 상태 코드
    - DEL (deleted)
    - PEND (pending)
    - RUN (running)
    - STOP (stopped)
    - FSTOP (failure stopped)
    private CommonCode cloudMssqlServerInstanceOperation;Cloud DB for MSSQL 서버 인스턴스 Operation 코드
    - NOOP (no operation)
    - CREAT (create)
    - START (start)
    - RSTRT (restart)
    - SETUP (setup)
    - STOP (stop)
    - FO (failover)
    - DEL (delete)
    - UPGD (upgrade)
    - DWGD (downgrade)
    - 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<String> accessControlGroupNoList = new ArrayList<>();ACG 번호 목록

    예시

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

    호출 예시

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

    ncloud vmssql createCloudMssqlInstance --regionCode FKR --vpcNo ****83 --subnetNo ****91 --mirrorSubnetNo ****92 --cloudMssqlServiceName test-**** --configGroupNo **9 --cloudMssqlImageProductCode SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100 --cloudMssqlProductCode SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002 --dataStorageTypeCode SSD --isHa true --isMultiZone true --backupFileRetentionPeriod 10 --backupTime 00:15 --isAutomaticBackup true --cloudMssqlUserName test**** --cloudMssqlUserPassword ******** --cloudMssqlPort 1433 --characterSetName Korean_Wansung_CI_AS
    

    응답 예시

    응답 예시

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

    응답 결과 포맷 타입(output)이 json 일 때

    {
      "createCloudMssqlInstanceResponse": {
        "requestId": "c04bfdd1-e27e-4006-9bc3-bc37840ce1dd",
        "returnCode": 0,
        "returnMessage": "success",
        "totalRows": 1,
        "cloudMssqlInstanceList": [
          {
            "cloudMssqlInstanceNo": "****890",
            "cloudMssqlServiceName": "test-****",
            "cloudMssqlInstanceStatusName": "creating",
            "cloudMssqlInstanceStatus": {
              "code": "INIT",
              "codeName": "CLOUD DATABASE(VPC) Init State"
            },
            "cloudMssqlInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Creat OP"
            },
            "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100",
            "isHa": true,
            "isMultiZone": true,
            "license": {
              "code": "GPL",
              "codeName": "General Public License"
            },
            "cloudMssqlPort": 1433,
            "backupFileRetentionPeriod": 10,
            "backupTime": "00:15",
            "configGroupNo": "**9",
            "configGroupName": "test-****-config",
            "engineVersion": "MSSQL 15.0.2000.5 Standard Edition",
            "createDate": "2021-04-12T19:30:38+0900",
            "cloudMssqlServerInstanceList": [
              {
                "cloudMssqlServerName": "test-****-001-e04",
                "cloudMssqlServerRole": {
                  "code": "M",
                  "codeName": "Principal"
                },
                "cloudMssqlServerInstanceStatusName": "creating",
                "cloudMssqlServerInstanceStatus": {
                  "code": "PEND",
                  "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                },
                "cloudMssqlServerInstanceOperation": {
                  "code": "CREAT",
                  "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                },
                "regionCode": "FKR",
                "zoneCode": "FKR-1",
                "vpcNo": "****83",
                "subnetNo": "****91",
                "dataStorageSize": 10737418240,
                "cpuCount": 2,
                "memorySize": 8589934592,
                "isPublicSubnet": true,
                "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
                "createDate": "2021-05-27T19:00:00+0900",
                "dataStorageType": {
                  "code": "SSD",
                  "codeName": "SSD"
                }
              },
              {
                "cloudMssqlServerName": "test-****-001-e05",
                "cloudMssqlServerRole": {
                  "code": "H",
                  "codeName": "Mirror"
                },
                "cloudMssqlServerInstanceStatusName": "creating",
                "cloudMssqlServerInstanceStatus": {
                  "code": "PEND",
                  "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                },
                "cloudMssqlServerInstanceOperation": {
                  "code": "CREAT",
                  "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                },
                "regionCode": "FKR",
                "zoneCode": "FKR-2",
                "vpcNo": "****83",
                "subnetNo": "****92",
                "dataStorageSize": 10737418240,
                "cpuCount": 2,
                "memorySize": 8589934592,
                "isPublicSubnet": true,
                "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
                "createDate": "2021-05-27T19:00:00+0900",
                "dataStorageType": {
                  "code": "SSD",
                  "codeName": "SSD"
                }
              }
            ]
          }
        ]
      }
    }
    

    응답 결과 포맷 타입(responseFormatType)이 xml 일 때

    <createCloudMssqlInstanceResponse>
        <requestId>c04bfdd1-e27e-4006-9bc3-bc37840ce1dd</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudMssqlInstanceList>
            <cloudMssqlInstance>
                <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
                <cloudMssqlServiceName>test-****</cloudMssqlServiceName>
                <cloudMssqlInstanceStatusName>creating</cloudMssqlInstanceStatusName>
                <cloudMssqlInstanceStatus>
                    <code>INIT</code>
                    <codeName>CLOUD DATABASE(VPC) Init State</codeName>
                </cloudMssqlInstanceStatus>
                <cloudMssqlInstanceOperation>
                    <code>CREAT</code>
                    <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
                </cloudMssqlInstanceOperation>
                <cloudMssqlImageProductCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100</cloudMssqlImageProductCode>
                <isHa>true</isHa>
                <isMultiZone>true</isMultiZone>
                <license>
                    <code>GPL</code>
                    <codeName>General Public License</codeName>
                </license>
                <cloudMssqlPort>1433</cloudMssqlPort>
                <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
                <backupTime>00:15</backupTime>
                <configGroupNo>**9</configGroupNo>
                <configGroupName>test-****-config</configGroupName>
                <engineVersion>MSSQL 15.0.2000.5 Standard Edition</engineVersion>
                <createDate>2021-04-12T19:30:38+0900</createDate>
                <cloudMssqlServerInstanceList>
                    <cloudMssqlServerInstance>
                        <cloudMssqlServerName>test-****-001-e04</cloudMssqlServerName>
                        <cloudMssqlServerRole>
                            <code>M</code>
                            <codeName>Principal</codeName>
                        </cloudMssqlServerRole>
                        <cloudMssqlServerInstanceStatusName>creating</cloudMssqlServerInstanceStatusName>
                        <cloudMssqlServerInstanceStatus>
                            <code>PEND</code>
                            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                        </cloudMssqlServerInstanceStatus>
                        <cloudMssqlServerInstanceOperation>
                            <code>CREAT</code>
                            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                        </cloudMssqlServerInstanceOperation>
                        <regionCode>FKR</regionCode>
                        <zoneCode>FKR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <isPublicSubnet>true</isPublicSubnet>
                        <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                        <createDate>2021-05-27T19:00:00+0900</createDate>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                    </cloudMssqlServerInstance><cloudMssqlServerInstance>
                    <cloudMssqlServerName>test-****-001-e05</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>H</code>
                        <codeName>Mirror</codeName>
                    </cloudMssqlServerRole>
                    <cloudMssqlServerInstanceStatusName>creating</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudMssqlServerInstanceStatus>
                    <cloudMssqlServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudMssqlServerInstanceOperation>
                    <regionCode>FKR</regionCode>
                    <zoneCode>FKR-2</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****92</subnetNo>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <createDate>2021-05-27T19:00:00+0900</createDate>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                </cloudMssqlServerInstance>
                </cloudMssqlServerInstanceList>
            </cloudMssqlInstance>
        </cloudMssqlInstanceList>
    </createCloudMssqlInstanceResponse>
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.