getCloudCacheConfigGroupList

VPC環境で利用できます。

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

参考

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

getCloudCacheConfigGroupList API: Valkey、Redis DBMSを利用可能
getCloudRedisConfigGroupList API: Redis DBMSを利用可能

getCloudCacheConfigGroupList API

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

リクエスト

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

メソッド	URI
GET, POST	/getCloudCacheConfigGroupList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	照会対象 Cloud DB for Cache Config Groupリストのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`cloudCacheInstanceNo`	String	Optional	Cloud DB for Cacheインスタンス番号で絞り込み getCloudCacheInstanceListを通じて確認
`cloudCacheServiceName`	String	Optional	Cloud DB for Cacheインスタンス名で絞り込み getCloudCacheInstanceListを通じて確認
`configGroupNo`	String	Optional	Config Group番号で絞り込み getCloudCacheConfigGroupListを通じて確認
`configGroupName`	String	Optional	Config Group名で絞り込み getCloudCacheConfigGroupListを通じて確認
`cloudCacheImageProductCode`	String	Optional	照会対象 Config Groupのバージョンに対応する Cloud Cacheイメージ商品コードで絞り込み getCloudCacheImageProductListを通じて確認
`cloudCacheModeCode`	String	Optional	Cloud DB for Cacheの構成Cloud DB for Cacheの構成タイプで絞り込み `SIMPLE` \| `CLUSTER` getCloudCacheInstanceListを通じて確認
`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/getCloudCacheConfigGroupList
?regionCode=KR
&cloudCacheInstanceNo=****511
&cloudCacheServiceName=test-****
&configGroupNo=***9
&configGroupName=test-***-config
&cloudCacheImageProductCode=SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050
&cloudCacheModeCode=SIMPLE'
--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の場合

{
    "getCloudCacheConfigGroupListResponse": {
        "totalRows": 1,
        "cloudCacheConfigGroupList": [
            {
                "configGroupNo": "***9",
                "configGroupName": "test-***-config",
                "configGroupDescription": "decription",
                "configGroupStatusName": "running",
                "configGroupStatus": {
                    "code": "RUN",
                    "codeName": "CONFIG GROUP Running状態"
                },
                "cloudCacheVersion": "7.2.11-simple",
                "cloudCacheDbmsCode": "Redis",
                "createDate": "2024-07-01T16:36:38+0900",
                "modifyDate": "2024-07-01T16:36:40+0900",
                "cloudCacheInstanceNoList": [
                    "****511"
                ]
            }
        ],
        "requestId": "8d112bd6-****-****-****-ab3793ad0676",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudCacheConfigGroupListResponse>
    <requestId>8d112bd6-****-****-****-ab3793ad0676</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudCacheConfigGroupList>
        <cloudCacheConfigGroup>
            <configGroupNo>***9</configGroupNo>
            <configGroupName>test-***-config</configGroupName>
            <configGroupDescription>decription</configGroupDescription>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running状態</codeName>
            </configGroupStatus>
            <cloudCacheVersion>7.2.11-simple</cloudCacheVersion>
            <cloudCacheDbmsCode>Valkey</cloudCacheDbmsCode>
            <createDate>2024-07-01T16:36:38+0900</createDate>
            <modifyDate>2024-07-01T16:36:40+0900</modifyDate>
            <cloudCacheInstanceNoList>
                <cloudCacheInstanceNo>****511</cloudCacheInstanceNo>
            </cloudCacheInstanceNoList>
        </cloudCacheConfigGroup>
    </cloudCacheConfigGroupList>
</getCloudCacheConfigGroupListResponse>

getCloudRedisConfigGroupList API

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