deleteCloudMssqlInstance

Prev Next

Available in VPC

Delete 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 /vmssql/v2/deleteCloudMssqlInstance
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) request headers.

Request query parameter

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code of the Cloud DB for MSSQL instance to delete
  • See getRegionList
  • First Region of the getRegionList query result (default)
cloudMssqlInstanceNo String Required Cloud DB for MSSQL instance number
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/deleteCloudMssqlInstance
?regionCode=KR
&cloudMssqlInstanceNo=2529****
&responseFormatType=xml' \
--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 information about the HTTP status codes common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) response status codes.

Response example

The following is a sample response.

  • If responseFormatType=json

    {
        "deleteCloudMssqlInstanceResponse": {
            "totalRows": 1,
            "cloudMssqlInstanceList": [
                {
                    "cloudMssqlInstanceNo": "2529****",
                    "cloudMssqlServiceName": "mssql006",
                    "cloudMssqlInstanceStatusName": "deleted",
                    "cloudMssqlInstanceStatus": {
                        "code": "DEL",
                        "codeName": "CLOUD DATABASE(VPC) Deleted State"
                    },
                    "cloudMssqlInstanceOperation": {
                        "code": "DEL",
                        "codeName": "CLOUD DATABASE(VPC) Delete 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": "07:00",
                    "configGroupNo": "0",
                    "configGroupName": "mssql_2019_default",
                    "engineVersion": "MSSQL 15.0.4355.3 Enterprise Edition",
                    "createDate": "2024-07-01T15:58:38+0900",
                    "dbCollation": "Korean_Wansung_CI_AS",
                    "cloudMssqlServerInstanceList": [
                        {
                            "cloudMssqlServerInstanceNo": "2528****",
                            "cloudMssqlServerName": "m-2529****-001",
                            "cloudMssqlServerRole": {
                                "code": "M",
                                "codeName": "Principal"
                            },
                            "cloudMssqlServerInstanceStatusName": "deleting",
                            "cloudMssqlServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudMssqlServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete 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-07-01T15:58:38+0900",
                            "uptime": "2024-07-01T16:24:55+0900",
                            "dataStorageType": {
                                "code": "SSD",
                                "codeName": "SSD"
                            },
                            "usedDataStorageSize": 1073741824
                        },
                        {
                            "cloudMssqlServerInstanceNo": "2529****",
                            "cloudMssqlServerName": "m-2529****-002",
                            "cloudMssqlServerRole": {
                                "code": "H",
                                "codeName": "Mirror"
                            },
                            "cloudMssqlServerInstanceStatusName": "deleting",
                            "cloudMssqlServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudMssqlServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete 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-07-01T15:58:38+0900",
                            "uptime": "2024-07-01T16:37:12+0900",
                            "dataStorageType": {
                                "code": "SSD",
                                "codeName": "SSD"
                            },
                            "usedDataStorageSize": 1073741824
                        }
                    ],
                    "accessControlGroupNoList": [
                        "186***"
                    ]
                }
            ],
            "requestId": "974b0299-****-****-****-64afa1431db3",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • If responseFormatType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
    <deleteCloudMssqlInstanceResponse>
        <requestId>974b0299-****-****-****-64afa1431db3</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudMssqlInstanceList>
            <cloudMssqlInstance>
                <cloudMssqlInstanceNo>2529****</cloudMssqlInstanceNo>
                <cloudMssqlServiceName>mssql006</cloudMssqlServiceName>
                <cloudMssqlInstanceStatusName>deleted</cloudMssqlInstanceStatusName>
                <cloudMssqlInstanceStatus>
                    <code>DEL</code>
                    <codeName>CLOUD DATABASE(VPC) Deleted State</codeName>
                </cloudMssqlInstanceStatus>
                <cloudMssqlInstanceOperation>
                    <code>DEL</code>
                    <codeName>CLOUD DATABASE(VPC) Delete 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>07:00</backupTime>
                <configGroupNo>0</configGroupNo>
                <configGroupName>mssql_2019_default</configGroupName>
                <engineVersion>MSSQL 15.0.4355.3 Enterprise Edition</engineVersion>
                <createDate>2024-07-01T15:58:38+0900</createDate>
                <dbCollation>Korean_Wansung_CI_AS</dbCollation>
                <cloudMssqlServerInstanceList>
                    <cloudMssqlServerInstance>
                        <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo>
                        <cloudMssqlServerName>m-2529****-001</cloudMssqlServerName>
                        <cloudMssqlServerRole>
                            <code>M</code>
                            <codeName>Principal</codeName>
                        </cloudMssqlServerRole>
                        <cloudMssqlServerInstanceStatusName>deleting</cloudMssqlServerInstanceStatusName>
                        <cloudMssqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudMssqlServerInstanceStatus>
                        <cloudMssqlServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete 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-07-01T15:58:38+0900</createDate>
                        <uptime>2024-07-01T16:24:55+0900</uptime>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <usedDataStorageSize>1073741824</usedDataStorageSize>
                    </cloudMssqlServerInstance>
                    <cloudMssqlServerInstance>
                        <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo>
                        <cloudMssqlServerName>m-2529****-002</cloudMssqlServerName>
                        <cloudMssqlServerRole>
                            <code>H</code>
                            <codeName>Mirror</codeName>
                        </cloudMssqlServerRole>
                        <cloudMssqlServerInstanceStatusName>deleting</cloudMssqlServerInstanceStatusName>
                        <cloudMssqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudMssqlServerInstanceStatus>
                        <cloudMssqlServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete 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-07-01T15:58:38+0900</createDate>
                        <uptime>2024-07-01T16:37:12+0900</uptime>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <usedDataStorageSize>1073741824</usedDataStorageSize>
                    </cloudMssqlServerInstance>
                </cloudMssqlServerInstanceList>
                <accessControlGroupNoList>
                    <accessControlGroupNo>186***</accessControlGroupNo>
                </accessControlGroupNoList>
            </cloudMssqlInstance>
        </cloudMssqlInstanceList>
    </deleteCloudMssqlInstanceResponse>