リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET, POST	/deleteCloudMssqlInstance

リクエストヘッダ

Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	削除対象の Cloud DB for MSSQLインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`cloudMssqlInstanceNo`	String	Required	Cloud DB for MSSQLインスタンス番号 Slaveサーバインスタンスがある場合、削除不可 getCloudMssqlInstanceListを通じて確認
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudMssqlInstanceListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

responseFormetType=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"
    }
}

responseFormetType=xml(デフォルト)の場合

<?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>

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Cloud DB for MSSQL