getCloudCacheConfigGroupVersionList

Prev Next

VPC環境で利用できます。

Cloud DB for Cache Config Groupのバージョンリストを照会します。

参考

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

  • getCloudCacheConfigGroupVersionList API: Valkey、Redis DBMSを利用可能
  • getCloudRedisConfigGroupVersionList API: Redis DBMSを利用可能

getCloudCacheConfigGroupVersionList API

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

リクエスト

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

メソッド URI
GET, POST /getCloudCacheConfigGroupVersionList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Config Groupバージョンリストのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
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/getCloudCacheConfigGroupVersionList
?cloudCacheDbmsCode=Redis
?regionCode=KR'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "getCloudCacheConfigGroupVersionListResponse": {
        "totalRows": 8,
        "cloudCacheConfigGroupVersionList": [
            {
                "cacheVersion": "7.2.11-simple"
            },
            {
                "cacheVersion": "7.2.8-simple"
            },
            {
                "cacheVersion": "7.2.6-simple"
            },
            {
                "cacheVersion": "7.0.15-simple"
            },
            {
                "cacheVersion": "7.0.13-simple"
            },
            {
                "cacheVersion": "6.2.20-simple"
            },
            {
                "cacheVersion": "6.2.14-simple"
            },
            {
                "cacheVersion": "6.2.11-simple"
            },
            {
                "cacheVersion": "6.2.4-simple"
            }
        ],
        "requestId": "eb510376-****-****-****-1c76df3e0bd8",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<getCloudCacheConfigGroupVersionListResponse>
    <requestId>eb510376-****-****-****-1c76df3e0bd8</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>8</totalRows>
    <cloudCacheConfigGroupVersionList>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>7.2.11-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>7.2.8-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>7.2.6-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>7.0.15-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>7.0.13-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>6.2.20-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>6.2.14-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>6.2.11-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
      <cloudCacheConfigGroupVersion>
        <cacheVersion>6.2.4-simple</cacheVersion>
      </cloudCacheConfigGroupVersion>
    </cloudCacheConfigGroupVersionList>
</getCloudCacheConfigGroupVersionListResponse>

getCloudRedisConfigGroupVersionList API

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

リクエスト

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

メソッド URI
GET, POST /getCloudRedisConfigGroupVersionList

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisConfigGroupVersionList
?regionCode=KR'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
        "getCloudRedisConfigGroupVersionListResponse": {
            "totalRows": 8,
            "cloudRedisConfigGroupVersionList": [
                {
                    "redisVersion": "7.2.11-simple"
                },
                {
                    "redisVersion": "7.2.11-cluster"
                },
                {
                    "redisVersion": "7.2.8-simple"
                },
                {
                    "redisVersion": "7.2.8-cluster"
                },
                {
                    "redisVersion": "7.2.6-simple"
                },
                {
                    "redisVersion": "7.2.6-cluster"
                },
                {
                    "redisVersion": "7.0.15-cluster"
                },
                {
                    "redisVersion": "7.0.15-simple"
                },
                {
                    "redisVersion": "7.0.13-simple"
                },
                {
                    "redisVersion": "7.0.13-cluster"
                },
                {
                    "redisVersion": "5.0.14-cluster"
                },
                {
                    "redisVersion": "5.0.14-simple"
                },
                {
                    "redisVersion": "4.0.14-cluster"
                },
                {
                    "redisVersion": "4.0.14-simple"
                }
            ],
            "requestId": "eb510376-****-****-****-1c76df3e0bd8",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisConfigGroupVersionListResponse>
        <requestId>eb510376-****-****-****-1c76df3e0bd8</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>8</totalRows>
        <cloudRedisConfigGroupVersionList>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.2.11-cluster</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.2.11-simple</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.2.8-simple</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.2.8-cluster</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.2.6-simple</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.2.6-cluster</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.0.15-simple</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.0.15-cluster</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.0.13-cluster</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>7.0.13-simple</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>5.0.14-cluster</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>5.0.14-simple</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>4.0.14-cluster</redisVersion>
              </cloudRedisConfigGroupVersion>
              <cloudRedisConfigGroupVersion>
                    <redisVersion>4.0.14-simple</redisVersion>
          </cloudRedisConfigGroupVersion>
    </cloudRedisConfigGroupVersionList>
    </getCloudRedisConfigGroupVersionListResponse>