getCloudRedisConfigGroupList

VPC環境で利用できます。

Cloud DB for Redis Config Groupリストを照会します。

リクエスト

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

リクエストヘッダ

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

リクエストパラメータ

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisConfigGroupList
?regionCode=KR
&cloudRedisInstanceNo=****511
&cloudRedisServiceName=test-****
&configGroupNo=***9
&configGroupName=test-***-config
&cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050
&cloudRedisModeCode=CLUSTER'
--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の場合

{
    "getCloudRedisConfigGroupListResponse": {
        "totalRows": 1,
        "cloudRedisConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "running",
                "configGroupStatus": {
                    "code": "RUN",
                    "codeName": "CONFIG GROUP Running State"
                },
                "cloudRedisVersion": "7.0.15-cluster",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-01T16:36:40+0900",
                "cloudRedisInstanceNoList": [
                    "****511"
                ]
            }
        ],
        "requestId": "8d112bd6-****-****-****-ab3793ad0676",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudRedisConfigGroupListResponse>
    <requestId>8d112bd6-****-****-****-ab3793ad0676</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudRedisConfigGroupList>
        <cloudRedisConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <cloudRedisVersion>7.0.15-cluster</cloudRedisVersion>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-01T16:36:40+0900</modifyDate>
            <cloudRedisInstanceNoList>
                <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
            </cloudRedisInstanceNoList>
        </cloudRedisConfigGroup>
    </cloudRedisConfigGroupList>
</getCloudRedisConfigGroupListResponse>