Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createCloudCacheConfigGroup

Prev Next

VPC環境で利用できます。

Cloud DB for Cache Config Groupを作成します。
Config Groupでは、作成した Redis Serverをグループ化し、グループに属するサーバに同じ設定値を指定して効率的に管理できます。

参考

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

  • createCloudCacheConfigGroup API: Valkey、Redis DBMSを利用可能
  • createCloudRedisConfigGroup API: Redis DBMSを利用可能

createCloudCacheConfigGroup API

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

リクエスト

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

メソッド URI
GET | POST /vcache/v2/createCloudCacheConfigGroup
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional Config Groupを作成する Cloud DB for Cacheインスタンスのリージョンコード
  • getRegionListを参照
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudCacheVersion String Required 作成する ConfigGroupのバージョンと Cloud DB for Cacheの構成情報
  • 7.2.11-simple
  • Config Groupの構成情報と DB Serverのタイプ(Cluster/Simple)が一致しないと、Cacheクラスタは作成できない
configGroupName String Required 作成する Config Groupサービス名
  • 英字の小文字、数字、記号の「-」のみ使用して3~15文字以内で入力
  • 文字列の先頭文字は英字、末尾文字は英字または数字のみ使用可能
configGroupDescription String Optional 作成する Config Groupの説明
  • 0~255文字
cloudCacheDbmsCode String Optional Cloud DB for Cacheインスタンスの DBMSコード
  • Redis (デフォルト) | Valkey
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/createCloudCacheConfigGroup
?regionCode=KR
&cloudCacheVersion=7.0.15-cluster
&configGroupName=test-***-config
&configGroupDescription=description
&cloudCacheDbmsCode=Redis' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

Cloud DB for Cache (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for Cache (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "createCloudCacheConfigGroupResponse": {
        "totalRows": 1,
        "cloudCacheConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "settingUp",
                "configGroupStatus": {
                    "code": "SETUP",
                    "codeName": "CONFIG GROUP Setup State"
                },
                "cloudCacheVersion": "7.0.15-cluster",
                "cloudCacheDbmsCode": "Redis",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-01T16:36:38+0900"
            }
        ],
        "requestId": "1af809fc-****-****-****-3ca2a105b758",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<createCloudCacheConfigGroupResponse>
    <requestId>1af809fc-****-****-****-3ca2a105b758</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheConfigGroupList>
        <cloudCacheConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>settingUp</configGroupStatusName>
            <configGroupStatus>
                <code>SETUP</code>
                <codeName>CONFIG GROUP Setup State</codeName>
            </configGroupStatus>
            <cloudCacheVersion>7.0.15-cluster</cloudCacheVersion>
            <cloudCacheDbmsCode>Redis</cloudCacheDbmsCode>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-01T16:36:38+0900</modifyDate>
        </cloudCacheConfigGroup>
    </cloudCacheConfigGroupList>
</createCloudCacheConfigGroupResponse>

createCloudRedisConfigGroup API

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

リクエスト

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

メソッド URI
GET | POST /vredis/v2/createCloudRedisConfigGroup
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional Config Groupを作成する Cloud DB for Cacheインスタンスのリージョンコード
  • getRegionListを参照
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudRedisVersion String Required 作成する ConfigGroupのバージョンと Cloud DB for Cacheの構成情報
  • 4.0.14-cluster | 4.0.14-simple | 5.0.14-cluster | 5.0.14-simple | 7.0.13-cluster | 7.0.13-simple | 7.0.15-cluster | 7.0.15-simple | 7.2.6-cluster | 7.2.6-simple | 7.2.8-cluster | 7.2.8-simple | 7.2.11-cluster | 7.2.11-simple
  • Config Groupの構成情報と Redis Serverのタイプ(Cluster/Simple)が一致しないと、Redisクラスタは作成できない
configGroupName String Required 作成する Config Groupサービス名
  • 英字の小文字、数字、記号の「-」のみ使用して3~15文字以内で入力
  • 文字列の先頭文字は英字、末尾文字は英字または数字のみ使用可能
configGroupDescription String Optional 作成する Config Groupの説明
  • 0~255文字
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/createCloudRedisConfigGroup
?regionCode=KR
&cloudRedisVersion=7.0.15-cluster
&configGroupName=test-***-config
&configGroupDescription=decription' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

Cloud DB for Cache (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for Cache (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

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

  • responseFormatType=jsonの場合

    {
    "createCloudRedisConfigGroupResponse": {
        "totalRows": 1,
        "cloudRedisConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "settingUp",
                "configGroupStatus": {
                    "code": "SETUP",
                    "codeName": "CONFIG GROUP Setup State"
                },
                "cloudRedisVersion": "7.0.15-cluster",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-01T16:36:38+0900"
            }
        ],
        "requestId": "1af809fc-****-****-****-3ca2a105b758",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

    <?xml version="1.0" encoding="UTF-8"?>
<createCloudRedisConfigGroupResponse>
    <requestId>1af809fc-****-****-****-3ca2a105b758</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisConfigGroupList>
        <cloudRedisConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>settingUp</configGroupStatusName>
            <configGroupStatus>
                <code>SETUP</code>
                <codeName>CONFIG GROUP Setup State</codeName>
            </configGroupStatus>
            <cloudRedisVersion>7.0.15-cluster</cloudRedisVersion>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-01T16:36:38+0900</modifyDate>
        </cloudRedisConfigGroup>
    </cloudRedisConfigGroupList>
</createCloudRedisConfigGroupResponse>
事業者登録番号: 129-86-31394 通信販売業申告番号:第2009-京畿城南-0510号
代表取締役: キム・ユウォン アドレス: 13561 京畿道 城南市 盆唐区 仏亭路6 グリーンファクトリー, 17~26F お客様センターの代表電話: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.