deleteCloudRedisInstance
    • PDF

    deleteCloudRedisInstance

    • PDF

    Article summary

    Available in VPC

    Delete a Cloud DB for Redis instance.

    Request

    The following describes the request format for the endpoint. The request format is as follows:

    MethodURI
    GET, POST/deleteCloudRedisInstance

    Request headers

    For headers common to Cloud DB for Redis APIs, see Cloud DB for Redis request headers.

    Request parameter

    The following describes the parameters.

    FieldTypeRequiredDescription
    regionCodeStringOptionalRegion code of the Cloud DB for Redis instance to delete
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    cloudRedisInstanceNoStringRequiredCloud DB for Redis instance number
    responseFormatTypeStringOptionalFormat of the response result
    • xml (default) | json

    Request example

    The following is a sample request.

    curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/deleteCloudRedisInstance
    ?regionCode=KR
    &cloudRedisInstanceNo=****511'
    --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 CloudRedisInstanceList 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 responseFormatType=json
    {
        "deleteCloudRedisInstanceResponse": {
            "totalRows": 1,
            "cloudRedisInstanceList": [
                {
                    "cloudRedisInstanceNo": "****511",
                    "cloudRedisServiceName": "test-****",
                    "cloudRedisInstanceStatusName": "deleted",
                    "cloudRedisInstanceStatus": {
                        "code": "DEL",
                        "codeName": "CLOUD DATABASE(VPC) Deleted State"
                    },
                    "cloudRedisInstanceOperation": {
                        "code": "DEL",
                        "codeName": "CLOUD DATABASE(VPC) Delete OP"
                    },
                    "cloudRedisImageProductCode": "SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050",
                    "engineVersion": "REDIS 7.0.15",
                    "licence": {
                        "code": "BSD",
                        "codeName": "Berkeley Software Distribution"
                    },
                    "cloudRedisPort": 6379,
                    "isHa": true,
                    "isBackup": true,
                    "backupTime": "00:15",
                    "backupFileRetentionPeriod": 7,
                    "backupSchedule": "AUTO",
                    "cloudRedisServerPrefix": "test-****",
                    "generationCode": "G2",
                    "role": {
                        "code": "CLUSTER",
                        "codeName": "CLOUD REDIS(VPC) Cluster Role"
                    },
                    "createDate": "2024-07-01T16:59:21+0900",
                    "accessControlGroupNoList": [
                        "**50"
                    ],
                    "masterNodeCount": 3,
                    "slaveNodeCount": 3,
                    "configGroupNo": "***9",
                    "configGroupName": "test-***-config",
                    "cloudRedisServerInstanceList": [
                        {
                            "cloudRedisServerInstanceNo": "****613",
                            "cloudRedisServerName": "test-****-001-001-ehs",
                            "cloudRedisServerRole": {
                                "code": "M",
                                "codeName": "Master"
                            },
                            "cloudRedisServerInstanceStatusName": "deleting",
                            "cloudRedisServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudRedisServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                            },
                            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "privateDomain": "redisc-*****.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"
                        },
                        {
                            "cloudRedisServerInstanceNo": "****616",
                            "cloudRedisServerName": "test-****-002-001-eht",
                            "cloudRedisServerRole": {
                                "code": "M",
                                "codeName": "Master"
                            },
                            "cloudRedisServerInstanceStatusName": "deleting",
                            "cloudRedisServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudRedisServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                            },
                            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "privateDomain": "redisc-*****.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"
                        },
                        {
                            "cloudRedisServerInstanceNo": "****619",
                            "cloudRedisServerName": "test-****-003-001-ehu",
                            "cloudRedisServerRole": {
                                "code": "M",
                                "codeName": "Master"
                            },
                            "cloudRedisServerInstanceStatusName": "deleting",
                            "cloudRedisServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudRedisServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                            },
                            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "privateDomain": "redisc-*****.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"
                        },
                        {
                            "cloudRedisServerInstanceNo": "****622",
                            "cloudRedisServerName": "test-****-001-002-ehv",
                            "cloudRedisServerRole": {
                                "code": "S",
                                "codeName": "Slave"
                            },
                            "cloudRedisServerInstanceStatusName": "deleting",
                            "cloudRedisServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudRedisServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                            },
                            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "privateDomain": "redisc-*****.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"
                        },
                        {
                            "cloudRedisServerInstanceNo": "****625",
                            "cloudRedisServerName": "test-****-002-002-ehw",
                            "cloudRedisServerRole": {
                                "code": "S",
                                "codeName": "Slave"
                            },
                            "cloudRedisServerInstanceStatusName": "deleting",
                            "cloudRedisServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudRedisServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                            },
                            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "privateDomain": "redisc-*****.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"
                        },
                        {
                            "cloudRedisServerInstanceNo": "****628",
                            "cloudRedisServerName": "test-****-003-002-ehx",
                            "cloudRedisServerRole": {
                                "code": "S",
                                "codeName": "Slave"
                            },
                            "cloudRedisServerInstanceStatusName": "deleting",
                            "cloudRedisServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudRedisServerInstanceOperation": {
                                "code": "DEL",
                                "codeName": "CLOUD DATABASE(VPC) Server Delete OP"
                            },
                            "cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "privateDomain": "redisc-*****.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"
        }
    }
    
    • If responseFormatType=xml (default)
    <?xml version="1.0" encoding="UTF-8"?>
    <deleteCloudRedisInstanceResponse>
        <requestId>7a42520a-****-****-****-8fa6ef6a50bf</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudRedisInstanceList>
            <cloudRedisInstance>
                <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
                <cloudRedisServiceName>test-****</cloudRedisServiceName>
                <cloudRedisInstanceStatusName>deleted</cloudRedisInstanceStatusName>
                <cloudRedisInstanceStatus>
                    <code>DEL</code>
                    <codeName>CLOUD DATABASE(VPC) Deleted State</codeName>
                </cloudRedisInstanceStatus>
                <cloudRedisInstanceOperation>
                    <code>DEL</code>
                    <codeName>CLOUD DATABASE(VPC) Delete OP</codeName>
                </cloudRedisInstanceOperation>
                <cloudRedisImageProductCode>SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050</cloudRedisImageProductCode>
                <engineVersion>REDIS 7.0.15</engineVersion>
                <licence>
                    <code>BSD</code>
                    <codeName>Berkeley Software Distribution</codeName>
                </licence>
                <cloudRedisPort>6379</cloudRedisPort>
                <isHa>true</isHa>
                <isBackup>true</isBackup>
                <backupTime>00:15</backupTime>
                <backupFileRetentionPeriod>7</backupFileRetentionPeriod>
                <backupSchedule>AUTO</backupSchedule>
                <cloudRedisServerPrefix>test-****</cloudRedisServerPrefix>
                <generationCode>G2</generationCode>
                <role>
                    <code>CLUSTER</code>
                    <codeName>CLOUD REDIS(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>
                <cloudRedisServerInstanceList>
                    <cloudRedisServerInstance>
                        <cloudRedisServerInstanceNo>****613</cloudRedisServerInstanceNo>
                        <cloudRedisServerName>test-****-001-001-ehs</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>deleting</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-****.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>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerInstanceNo>****616</cloudRedisServerInstanceNo>
                        <cloudRedisServerName>test-****-002-001-eht</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>deleting</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-****.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>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerInstanceNo>****619</cloudRedisServerInstanceNo>
                        <cloudRedisServerName>test-****-003-001-ehu</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>deleting</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-****.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>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerInstanceNo>****622</cloudRedisServerInstanceNo>
                        <cloudRedisServerName>test-****-001-002-ehv</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>S</code>
                            <codeName>Slave</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>deleting</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-****.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>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerInstanceNo>****625</cloudRedisServerInstanceNo>
                        <cloudRedisServerName>test-****-002-002-ehw</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>S</code>
                            <codeName>Slave</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>deleting</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-****.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>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerInstanceNo>****628</cloudRedisServerInstanceNo>
                        <cloudRedisServerName>test-****-003-002-ehx</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>S</code>
                            <codeName>Slave</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>deleting</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>DEL</code>
                            <codeName>CLOUD DATABASE(VPC) Server Delete OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-****.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>
                    </cloudRedisServerInstance>
                </cloudRedisServerInstanceList>
            </cloudRedisInstance>
        </cloudRedisInstanceList>
    </deleteCloudRedisInstanceResponse>
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.