deleteCloudCacheInstance

VPC環境で利用できます。

Cloud DB for Cacheインスタンスを削除します。

参考

Cloud DB for Cache APIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。

deleteCloudCacheInstance API: Valkey、Redis DBMSを利用可能
deleteCloudRedisInstance API: Redis DBMSを利用可能

deleteCloudCacheInstance API

deleteCloudCacheInstance APIのリクエストおよびレスポンス形式を説明します。

リクエスト

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

メソッド	URI
GET, POST	/deleteCloudCacheInstance

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	削除対象 Cloud DB for Cacheインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`cloudCacheInstanceNo`	String	Required	Cloud DB for Cacheインスタンス番号 getCloudCacheInstanceListを通じて確認
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/deleteCloudCacheInstance
?regionCode=KR
&cloudCacheInstanceNo=****511'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormatType=jsonの場合

{
    "deleteCloudCacheInstanceResponse": {
        "totalRows": 1,
        "cloudCacheInstanceList": [
            {
                "cloudCacheInstanceNo": "****511",
                "cloudCacheServiceName": "test-****",
                "cloudCacheInstanceStatusName": "deleted",
                "cloudCacheInstanceStatus": {
                    "code": "DEL",
                    "codeName": "CLOUD DATABASE(VPC) Deleted State"
                },
                "cloudCacheInstanceOperation": {
                    "code": "DEL",
                    "codeName": "CLOUD DATABASE(VPC) Delete OP"
                },
                "cloudCacheImageProductCode": "	SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050",
                "engineVersion": "VALKEY 7.2.11",
                "licence": {
                    "code": "BSD",
                    "codeName": "Berkeley Software Distribution"
                },
                "cloudCachePort": 6379,
                "isHa": true,
                "isBackup": true,
                "backupTime": "00:15",
                "backupFileRetentionPeriod": 7,
                "backupSchedule": "AUTO",
                "cloudCacheServerPrefix": "test-****",
                "generationCode": "G2",
                "role": {
                    "code": "CLUSTER",
                    "codeName": "CLOUD CACHE(VPC) Cluster Role"
                },
                "createDate": "2024-07-01T16:59:21+0900",
                "accessControlGroupNoList": [
                    "**50"
                ],
                "masterNodeCount": 3,
                "slaveNodeCount": 3,
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "cloudCacheServerInstanceList": [
                    {
                        "cloudCacheServerInstanceNo": "****613",
                        "cloudCacheServerName": "test-****-001-001-ehs",
                        "cloudCacheServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudCacheServerInstanceStatusName": "deleting",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "DEL",
                            "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                        },
                        "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "cachec-*****.vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "uptime": "2024-07-01T17:03:43+0900",
                        "createDate": "2024-07-01T16:59:21+0900",
                        "slotName": "0-5460"
                    },
                    {
                        "cloudCacheServerInstanceNo": "****616",
                        "cloudCacheServerName": "test-****-002-001-eht",
                        "cloudCacheServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudCacheServerInstanceStatusName": "deleting",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "DEL",
                            "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                        },
                        "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "cachec-*****.vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "uptime": "2024-07-01T17:04:10+0900",
                        "createDate": "2024-07-01T16:59:21+0900",
                        "slotName": "5461-10922"
                    },
                    {
                        "cloudCacheServerInstanceNo": "****619",
                        "cloudCacheServerName": "test-****-003-001-ehu",
                        "cloudCacheServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudCacheServerInstanceStatusName": "deleting",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "DEL",
                            "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                        },
                        "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "cachec-*****.vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "uptime": "2024-07-01T17:04:06+0900",
                        "createDate": "2024-07-01T16:59:21+0900",
                        "slotName": "10923-16383"
                    },
                    {
                        "cloudCacheServerInstanceNo": "****622",
                        "cloudCacheServerName": "test-****-001-002-ehv",
                        "cloudCacheServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudCacheServerInstanceStatusName": "deleting",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "DEL",
                            "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                        },
                        "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "cachec-*****.vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "uptime": "2024-07-02T10:31:18+0900",
                        "createDate": "2024-07-01T16:59:21+0900",
                        "slotName": "0-5460"
                    },
                    {
                        "cloudCacheServerInstanceNo": "****625",
                        "cloudCacheServerName": "test-****-002-002-ehw",
                        "cloudCacheServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudCacheServerInstanceStatusName": "deleting",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "DEL",
                            "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                        },
                        "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "cachec-*****.vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "uptime": "2024-07-01T17:03:42+0900",
                        "createDate": "2024-07-01T16:59:21+0900",
                        "slotName": "5461-10922"
                    },
                    {
                        "cloudCacheServerInstanceNo": "****628",
                        "cloudCacheServerName": "test-****-003-002-ehx",
                        "cloudCacheServerRole": {
                            "code": "S",
                            "codeName": "Slave"
                        },
                        "cloudCacheServerInstanceStatusName": "deleting",
                        "cloudCacheServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) Server Running State"
                        },
                        "cloudCacheServerInstanceOperation": {
                            "code": "DEL",
                            "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                        },
                        "cloudCacheProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                        "regionCode": "KR",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateDomain": "cachec-*****.vpc-cdb.ntruss.com",
                        "cpuCount": 4,
                        "memorySize": 1610612736,
                        "osMemorySize": 2147483648,
                        "uptime": "2024-07-01T17:03:47+0900",
                        "createDate": "2024-07-01T16:59:21+0900",
                        "slotName": "10923-16383"
                    }
                ]
            }
        ],
        "requestId": "7a42520a-****-****-****-8fa6ef6a50bf",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<deleteCloudCacheInstanceResponse>
    <requestId>7a42520a-****-****-****-8fa6ef6a50bf</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheInstanceList>
        <cloudCacheInstance>
            <cloudCacheInstanceNo>****511</cloudCacheInstanceNo>
            <cloudCacheServiceName>test-****</cloudCacheServiceName>
            <cloudCacheInstanceStatusName>deleted</cloudCacheInstanceStatusName>
            <cloudCacheInstanceStatus>
                <code>DEL</code>
                <codeName>CLOUD DATABASE(VPC) Deleted State</codeName>
            </cloudCacheInstanceStatus>
            <cloudCacheInstanceOperation>
                <code>DEL</code>
                <codeName>CLOUD DATABASE(VPC) Delete OP</codeName>
            </cloudCacheInstanceOperation>
            <cloudCacheImageProductCode>	SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050</cloudCacheImageProductCode>
            <engineVersion>VALKEY 7.2.11</engineVersion>
            <licence>
                <code>BSD</code>
                <codeName>Berkeley Software Distribution</codeName>
            </licence>
            <cloudCachePort>6379</cloudCachePort>
            <isHa>true</isHa>
            <isBackup>true</isBackup>
            <backupTime>00:15</backupTime>
            <backupFileRetentionPeriod>7</backupFileRetentionPeriod>
            <backupSchedule>AUTO</backupSchedule>
            <cloudCacheServerPrefix>test-****</cloudCacheServerPrefix>
            <generationCode>G2</generationCode>
            <role>
                <code>CLUSTER</code>
                <codeName>CLOUD CACHE(VPC) Cluster Role</codeName>
            </role>
            <createDate>2024-07-01T16:59:21+0900</createDate>
            <accessControlGroupNoList>
                <accessControlGroupNo>**50</accessControlGroupNo>
            </accessControlGroupNoList>
            <masterNodeCount>3</masterNodeCount>
            <slaveNodeCount>3</slaveNodeCount>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <cloudCacheServerInstanceList>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****613</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-001-001-ehs</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>deleting</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <privateDomain>cachec-****.vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2024-07-01T17:03:43+0900</uptime>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                    <slotName>0-5460</slotName>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****616</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-002-001-eht</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>deleting</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <privateDomain>cachec-****.vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2024-07-01T17:04:10+0900</uptime>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                    <slotName>5461-10922</slotName>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****619</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-003-001-ehu</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>deleting</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <privateDomain>cachec-****.vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2024-07-01T17:04:06+0900</uptime>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                    <slotName>10923-16383</slotName>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****622</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-001-002-ehv</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>deleting</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <privateDomain>cachec-****.vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2024-07-02T10:31:18+0900</uptime>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                    <slotName>0-5460</slotName>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****625</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-002-002-ehw</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>deleting</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <privateDomain>cachec-****.vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2024-07-01T17:03:42+0900</uptime>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                    <slotName>5461-10922</slotName>
                </cloudCacheServerInstance>
                <cloudCacheServerInstance>
                    <cloudCacheServerInstanceNo>****628</cloudCacheServerInstanceNo>
                    <cloudCacheServerName>test-****-003-002-ehx</cloudCacheServerName>
                    <cloudCacheServerRole>
                        <code>S</code>
                        <codeName>Slave</codeName>
                    </cloudCacheServerRole>
                    <cloudCacheServerInstanceStatusName>deleting</cloudCacheServerInstanceStatusName>
                    <cloudCacheServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudCacheServerInstanceStatus>
                    <cloudCacheServerInstanceOperation>
                        <code>DEL</code>
                        <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                    </cloudCacheServerInstanceOperation>
                    <cloudCacheProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudCacheProductCode>
                    <regionCode>KR</regionCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <privateDomain>cachec-****.vpc-cdb.ntruss.com</privateDomain>
                    <cpuCount>4</cpuCount>
                    <memorySize>1610612736</memorySize>
                    <osMemorySize>2147483648</osMemorySize>
                    <uptime>2024-07-01T17:03:47+0900</uptime>
                    <createDate>2024-07-01T16:59:21+0900</createDate>
                    <slotName>10923-16383</slotName>
                </cloudCacheServerInstance>
            </cloudCacheServerInstanceList>
        </cloudCacheInstance>
    </cloudCacheInstanceList>
</deleteCloudCacheInstanceResponse>

deleteCloudRedisInstance API

deleteCloudRedisInstance APIのリクエストおよびレスポンス形式を説明します。