createCloudMssqlInstance

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

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

요청

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

메서드	URI
GET, POST	/createCloudMssqlInstance

요청 헤더

Cloud DB for MSSQL (VPC) API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for MSSQL (VPC) 요청 헤더를 참조해 주십시오.

요청 파라미터

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

필드	타입	필수 여부	설명
`regionCode`	String	Optional	생성할 Cloud DB for MSSQL 인스턴스의 리전 코드 getRegionList를 통해 확인 `getRegionList` 조회 결과의 첫 번째 리전(기본값)
`vpcNo`	String	Required	Cloud DB for MSSQL 인스턴스를 생성할 VPC 번호 getCloudMssqlTargetVpcList를 통해 확인
`subnetNo`	String	Required	Cloud DB for MSSQL 인스턴스에서 사용할 기본 네트워크 인터페이스의 Subnet 번호 getCloudMssqlTargetSubnetList를 통해 확인 Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청 가능 Cloud DB for MSSQL 인스턴스 생성 이후 Subnet 이전 불가
`mirrorSubnetNo`	String	Conditional	Mirror 서버의 Subnet 번호 Multi Zone인 CloudDB for MSSQL인 경우 필수 입력 getCloudMssqlTargetSubnetList를 통해 확인 Principal 서버의 Subnet과 존이 다르고, Public 또는 Private은 같아야 함
`cloudMssqlServiceName`	String	Required	생성할 Cloud DB for MSSQL 서비스 이름 3~15자로 영문자, 한글, 숫자, 특수문자 '-'을 허용
`configGroupNo`	String	Optional	Cloud DB for MSSQL Config Group 번호 사전에 생성한 Config Group을 서버 생성 시 적용 가능 별도의 Config Group이 없는 경우, 기본 제공되는 Config Group 중 선택 가능 getCloudMssqlConfigGroupList를 통해 확인 0 (기본값)
`cloudMssqlImageProductCode`	String	Optional	Cloud DB for MSSQL 이미지 상품 코드 getCloudMssqlImageProductList를 통해 확인 네이버 클라우드 플랫폼에서 자동 생성(기본값)
`cloudMssqlProductCode`	String	Optional	Cloud DB for MSSQL 상품 코드 생성할 Cloud DB for MSSQL 인스턴스의 서버 스펙을 결정 getCloudMssqlProductList를 통해 확인 최소 사양(기본값) 최소 사양의 기준: 1. 메모리 2. CPU 순서로 결정
`dataStorageTypeCode`	String	Optional	데이터 스토리지 타입 코드 설치 이후 데이터 스토리지 타입 변경 불가 `SSD` (기본값) \| `HDD`
`isHa`	Boolean	Required	고가용성 여부 `true` (고가용성 선택)인 경우 Mirror 서버를 포함한 2대의 서버로 생성되며 추가 요금 발생 `false`인 경우 `isMultiZone`, `mirrorSubnetNo` 파라미터는 사용되지 않음
`isMultiZone`	Boolean	Optional	Multi Zone 여부 `true` \| `false` (기본값) 고가용성 여부(`isHa`)가 `true`일 경우에만 입력 가능 `true`인 경우 Principal 서버와 Mirror 서버를 서로 다른 존에 생성하여 더욱 높은 가용성을 제공
`backupFileRetentionPeriod`	Integer	Optional	백업 파일 보관 기간(일) 1~30 (기본값: 1) 백업은 매일 수행되며, 백업 파일은 별도의 스토리지에 저장 요금은 사용하는 공간만큼만 과금
`backupTime`	String	Conditional	백업 시점 설정(HH:MM) 자동 백업 여부(`isAutomaticBackup`)가 `false`인 경우 필수 입력 15분 단위로 입력 가능 <예시> 01:15
`isAutomaticBackup`	Boolean	Optional	백업 시점 자동 설정 여부 `true` (기본값) \| `false` `true`인 경우 `backupTime`에 관계없이 백업 시간이 자동 설정됨
`cloudMssqlUserName`	String	Required	DB User 계정 아이디 4~16자로 영문자, 숫자, 특수문자 '_'를 허용하며 영문자로 시작해야 함
`cloudMssqlUserPassword`	String	Required	DB User 계정 패스워드 8~20자로 영문자, 숫자, 특수문자를 각 1자 이상 포함하여 조합 특수문자 ` " ' \ / & 및 공백 사용 불가
`cloudMssqlPort`	Integer	Optional	Cloud DB for MSSQL 인스턴스에 접근하기 위한 TCP 포트 번호 `1433` (기본값) 지정 범위: 10000~20000
`characterSetName`	String	Optional	DB 문자셋 getCloudMssqlCharacterSetList를 통해 확인 한글과 영어 collation 중에서 선택 `Korean_Wansung_CI_AS` (기본값) \| `SQL_Latin1_General_CP1_CI_AS` `Korean_Wansung_CI_AS`: 한글 완성형 `SQL_Latin1_General_CP1_CI_AS`: 영문 버전
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/createCloudMssqlInstance
?regionCode=KR
&vpcNo=59***
&subnetNo=140***
&mirrorSubnetNo=158***
&cloudMssqlServiceName=mssql003
&configGroupNo=***
&cloudMssqlImageProductCode=SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043553.EE.B100
&cloudMssqlProductCode=SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002
&dataStorageTypeCode=SSD
&isHa=true
&isMultiZone=true
&backupFileRetentionPeriod=1
&backupTime=10:15
&isAutomaticBackup=false
&cloudMssqlUserName=user000
&cloudMssqlUserPassword=*********
&cloudMssqlPort=1433
&characterSetName=Korean_Wansung_CI_AS
&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를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

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

responseFormetType=json 일 때

{
    "createCloudMssqlInstanceResponse": {
        "totalRows": 1,
        "cloudMssqlInstanceList": [
                {
                    "cloudMssqlInstanceNo": "2528****",
                    "cloudMssqlServiceName": "mssql003",
                    "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.15043553.EE.B100",
                "isHa": true,
                "isMultiZone": true,
                "license": {
                    "code": "SPLA",
                    "codeName": "Service Provider License Agreement"
                },
                "cloudMssqlPort": 1433,
                "backupFileRetentionPeriod": 1,
                "backupTime": "10:15",
                "configGroupNo": "***",
                "configGroupName": "mssql_2019_default",
                "engineVersion": "MSSQL 15.0.4355.3 Enterprise Edition",
                "createDate": "2024-07-01T11:34:11+0900",
                "dbCollation": "Korean_Wansung_CI_AS",
                "cloudMssqlServerInstanceList": [
                    {
                        "cloudMssqlServerName": "m-2528****-001",
                        "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": "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",
                        "createDate": "2024-07-01T11:34:11+0900",
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        }
                    },
                    {
                        "cloudMssqlServerName": "m-2528****-002",
                        "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": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "59***",
                        "subnetNo": "158***",
                        "dataStorageSize": 107374182400,
                        "cpuCount": 2,
                        "memorySize": 4294967296,
                        "isPublicSubnet": true,
                        "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
                        "createDate": "2024-07-01T11:34:11+0900",
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        }
                    }
                ]
            }
        ],
        "requestId": "7e05dba1-****-****-****-e463eb447507",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormetType=xml (기본값) 일 때

<?xml version="1.0" encoding="UTF-8"?>
<createCloudMssqlInstanceResponse>
    <requestId>7e05dba1-****-****-****-e463eb447507</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <cloudMssqlInstance>
            <cloudMssqlInstanceNo>2528****</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>mssql003</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.15043553.EE.B100</cloudMssqlImageProductCode>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <license>
                <code>SPLA</code>
                <codeName>Service Provider License Agreement</codeName>
            </license>
            <cloudMssqlPort>1433</cloudMssqlPort>
            <backupFileRetentionPeriod>1</backupFileRetentionPeriod>
            <backupTime>10:15</backupTime>
            <configGroupNo>***</configGroupNo>
            <configGroupName>mssql_2019_default</configGroupName>
            <engineVersion>MSSQL 15.0.4355.3 Enterprise Edition</engineVersion>
            <createDate>2024-07-01T11:34:11+0900</createDate>
            <dbCollation>Korean_Wansung_CI_AS</dbCollation>
            <cloudMssqlServerInstanceList>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerName>m-2528****-001</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>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>
                    <createDate>2024-07-01T11:34:11+0900</createDate>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                </cloudMssqlServerInstance>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerName>m-2528****-002</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>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>59***</vpcNo>
                    <subnetNo>158***</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <createDate>2024-07-01T11:34:11+0900</createDate>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                </cloudMssqlServerInstance>
            </cloudMssqlServerInstanceList>
        </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</createCloudMssqlInstanceResponse>

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

What's Next

createCloudMssqlSlaveInstance

요청
응답

태그

Cloud DB for MSSQL