Available in VPC
Add a slave server instance to a Cloud DB for MSSQL instance.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET, POST | /createCloudMssqlSlaveInstance |
Request headers
For headers common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) request headers.
Request parameter
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
regionCode |
String | Optional | Region code of the Cloud DB for MSSQL instance for which you want to create a slave server instance
|
cloudMssqlInstanceNo |
String | Required | Cloud DB for MSSQL instance number
|
privateDomainPostfix |
String | Required | Private domain postfix of the slave server instance
|
subnetNo |
String | Conditional | Subnet number of the default network interface to be used in the Cloud DB for MSSQL instance
|
responseFormatType |
String | Optional | Format of the response result
|
Request example
The following is a sample request.
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/createCloudMssqlSlaveInstance
?regionNo=KR
&cloudMssqlInstanceNo=2517****
&privateDomainPostfix=002
&subnetNo=139***
&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}'
Response
The following describes the response format.
Response body
See CloudMssqlInstanceList for the response body.
Response status codes
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Response example
The following is a sample response.
-
If
responseFormetType=json{ "createCloudMssqlSlaveInstanceResponse": { "totalRows": 1, "cloudMssqlInstanceList": [ { "cloudMssqlInstanceNo": "2517****", "cloudMssqlServiceName": "mssql002", "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": "02:00", "configGroupNo": "0", "configGroupName": "mssql_2019_default", "engineVersion": "MSSQL 15.0.4355.3 Enterprise Edition", "createDate": "2024-06-25T10:18:57+0900", "dbCollation": "Korean_Wansung_CI_AS", "cloudMssqlServerInstanceList": [ { "cloudMssqlServerInstanceNo": "2517****", "cloudMssqlServerName": "m-2517****-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-06-25T10:18:57+0900", "uptime": "2024-06-25T10:48:04+0900", "dataStorageType": { "code": "SSD", "codeName": "SSD" }, "usedDataStorageSize": 1073741824 }, { "cloudMssqlServerInstanceNo": "2517****", "cloudMssqlServerName": "m-2517****-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-06-25T10:18:57+0900", "uptime": "2024-06-25T11:01:26+0900", "dataStorageType": { "code": "SSD", "codeName": "SSD" }, "usedDataStorageSize": 1073741824 }, { "cloudMssqlServerInstanceNo": "2529****", "cloudMssqlServerName": "m-2517****-005", "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:50:23+0900", "uptime": "2024-07-01T16:19:57+0900", "dataStorageType": { "code": "SSD", "codeName": "SSD" }, "usedDataStorageSize": 1073741824 }, { "cloudMssqlServerInstanceNo": "2529****", "cloudMssqlServerName": "m-2517****-006", "cloudMssqlServerRole": { "code": "S", "codeName": "Slave" }, "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-01T16:50:01+0900", "uptime": "2024-07-01T17:22:39+0900", "dataStorageType": { "code": "SSD", "codeName": "SSD" } } ], "accessControlGroupNoList": [ "184***" ] } ], "requestId": "ba3feb17-****-****-****-c326f4ca42e1", "returnCode": "0", "returnMessage": "success" } } -
If
responseFormetType=xml(default)<?xml version="1.0" encoding="UTF-8"?> <createCloudMssqlSlaveInstanceResponse> <requestId>ba3feb17-****-****-****-c326f4ca42e1</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <totalRows>1</totalRows> <cloudMssqlInstanceList> <cloudMssqlInstance> <cloudMssqlInstanceNo>2517****</cloudMssqlInstanceNo> <cloudMssqlServiceName>mssql002</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>02:00</backupTime> <configGroupNo>0</configGroupNo> <configGroupName>mssql_2019_default</configGroupName> <engineVersion>MSSQL 15.0.4355.3 Enterprise Edition</engineVersion> <createDate>2024-06-25T10:18:57+0900</createDate> <dbCollation>Korean_Wansung_CI_AS</dbCollation> <cloudMssqlServerInstanceList> <cloudMssqlServerInstance> <cloudMssqlServerInstanceNo>2517****</cloudMssqlServerInstanceNo> <cloudMssqlServerName>m-2517****-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-06-25T10:18:57+0900</createDate> <uptime>2024-06-25T10:48:04+0900</uptime> <dataStorageType> <code>SSD</code> <codeName>SSD</codeName> </dataStorageType> <usedDataStorageSize>1073741824</usedDataStorageSize> </cloudMssqlServerInstance> <cloudMssqlServerInstance> <cloudMssqlServerInstanceNo>2517****</cloudMssqlServerInstanceNo> <cloudMssqlServerName>m-2517****-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-06-25T10:18:57+0900</createDate> <uptime>2024-06-25T11:01:26+0900</uptime> <dataStorageType> <code>SSD</code> <codeName>SSD</codeName> </dataStorageType> <usedDataStorageSize>1073741824</usedDataStorageSize> </cloudMssqlServerInstance> <cloudMssqlServerInstance> <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo> <cloudMssqlServerName>m-2517****-005</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:50:23+0900</createDate> <uptime>2024-07-01T16:19:57+0900</uptime> <dataStorageType> <code>SSD</code> <codeName>SSD</codeName> </dataStorageType> <usedDataStorageSize>1073741824</usedDataStorageSize> </cloudMssqlServerInstance> <cloudMssqlServerInstance> <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo> <cloudMssqlServerName>m-2517****-006</cloudMssqlServerName> <cloudMssqlServerRole> <code>S</code> <codeName>Slave</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> <privateDomain>mssql-****-r002.vpc-cdb.ntruss.com</privateDomain> <createDate>2024-07-01T16:50:01+0900</createDate> <uptime>2024-07-01T17:22:39+0900</uptime> <dataStorageType> <code>SSD</code> <codeName>SSD</codeName> </dataStorageType> <usedDataStorageSize>1073741824</usedDataStorageSize> </cloudMssqlServerInstance> </cloudMssqlServerInstanceList> <accessControlGroupNoList> <accessControlGroupNo>184***</accessControlGroupNo> </accessControlGroupNoList> </cloudMssqlInstance> </cloudMssqlInstanceList> </createCloudMssqlSlaveInstanceResponse>