deleteCloudRedisConfigGroup
    • PDF

    deleteCloudRedisConfigGroup

    • PDF

    Article summary

    Available in VPC

    Delete a Cloud DB for Redis config group.

    Caution

    You can't delete a config group if a configured Redis service exists in the config group.
    If you want to delete it, then remove all settings for the configured Redis service and try again.

    Request

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

    MethodURI
    GET, POST/deleteCloudRedisConfigGroup

    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 config group to delete
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    configGroupNoStringRequiredConfig group 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/deleteCloudRedisConfigGroup
    ?regionCode=KR
    &configGroupNo=***9'
    --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 ConfigGroupList 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
    {
        "deleteCloudRedisConfigGroupResponse": {
            "totalRows": 1,
            "cloudRedisConfigGroupList": [
                {
                    "configGroupNo": "***9",
                    "configGroupName": "test-***-config",
                    "configGroupDescription": "decription",
                    "configGroupStatusName": "deleting",
                    "configGroupStatus": {
                        "code": "DELETING",
                        "codeName": "CONFIG GROUP Deleting State"
                    },
                    "cloudRedisVersion": "7.0.15-cluster",
                    "createDate": "2024-07-01T16:36:38+0900",
                    "modifyDate": "2024-07-02T08:45:55+0900"
                }
            ],
            "requestId": "94393e32-****-****-****-0ee9285a58b7",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • If responseFormatType=xml (default)
    <?xml version="1.0" encoding="UTF-8"?>
    <deleteCloudRedisConfigGroupResponse>
        <requestId>94393e32-****-****-****-0ee9285a58b7</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudRedisConfigGroupList>
            <cloudRedisConfigGroup>
                <configGroupNo>***9</configGroupNo>
                <configGroupName>test-***-config</configGroupName>
                <configGroupDescription>decription</configGroupDescription>
                <configGroupStatusName>deleting</configGroupStatusName>
                <configGroupStatus>
                    <code>DELETING</code>
                    <codeName>CONFIG GROUP Deleting State</codeName>
                </configGroupStatus>
                <cloudRedisVersion>7.0.15-cluster</cloudRedisVersion>
                <createDate>2024-07-01T16:36:38+0900</createDate>
                <modifyDate>2024-07-02T08:45:55+0900</modifyDate>
            </cloudRedisConfigGroup>
        </cloudRedisConfigGroupList>
    </deleteCloudRedisConfigGroupResponse>
    

    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.