deleteCloudCacheConfigGroup

Prev Next

VPC環境で利用できます。

Cloud DB for Cache Config Groupを削除します。

注意

Config Groupに設定された Redisサービスがある場合、削除できません。
削除するには、設定されていた Redisサービスの全体設定を解除してからもう一度お試しください。

参考

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

  • deleteCloudCacheConfigGroup API: Valkey、Redis DBMSを利用可能
  • deleteCloudRedisConfigGroup API: Redis DBMSを利用可能

deleteCloudCacheConfigGroup API

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

リクエスト

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

メソッド URI
GET, POST /deleteCloudCacheConfigGroup

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/deleteCloudCacheConfigGroup
?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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "deleteCloudCacheConfigGroupResponse": {
        "totalRows": 1,
        "cloudCacheConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "deleting",
                "configGroupStatus": {
                    "code": "DELETING",
                    "codeName": "CONFIG GROUP Deleting State"
                },
                "cloudCacheVersion": "7.0.15-cluster",
                "cloudCacheDbmsCode": "Redis",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-02T08:45:55+0900"
            }
        ],
        "requestId": "94393e32-****-****-****-0ee9285a58b7",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<deleteCloudCacheConfigGroupResponse>
    <requestId>94393e32-****-****-****-0ee9285a58b7</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheConfigGroupList>
        <cloudCacheConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>deleting</configGroupStatusName>
            <configGroupStatus>
                <code>DELETING</code>
                <codeName>CONFIG GROUP Deleting State</codeName>
            </configGroupStatus>
            <cloudCacheVersion>7.0.15-cluster</cloudCacheVersion>
            <cloudCacheDbmsCode>Valkey</cloudCacheDbmsCode>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-02T08:45:55+0900</modifyDate>
        </cloudCacheConfigGroup>
    </cloudCacheConfigGroupList>
</deleteCloudCacheConfigGroupResponse>

deleteCloudRedisConfigGroup API

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

リクエスト

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

メソッド URI
GET, POST /deleteCloudRedisConfigGroup

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • 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"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

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