createCloudCacheConfigGroup

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /createCloudRedisConfigGroup

リクエストヘッダ

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
  • 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をご参照ください。

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

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

レスポンス例

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

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