getCloudCacheImageProductList

Prev Next

VPC環境で利用できます。

Cloud DB for Cacheイメージ商品コードリストを照会します。

参考

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

  • getCloudCacheImageProductList API: Valkey、Redis DBMSを利用可能
  • getCloudRedisImageProductList API: Redis DBMSを利用可能

getCloudCacheImageProductList API

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

リクエスト

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

メソッド URI
GET, POST /getCloudCacheImageProductList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象 Cloud DB for Cacheイメージ商品コードリストのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
productCode String Optional Cloud DB for Cacheイメージ商品コードで絞り込み
exclusionProductCode String Optional Cloud DB for Cacheイメージ商品コードを除外して絞り込み
generationCode String Optional サーバの世代コードで絞り込み
  • G2 | G3
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/getCloudCacheImageProductList
?regionCode=KR
&productCode=SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "getCloudCacheImageProductListResponse": {
        "totalRows": 1,
        "productList": [
            {
                "productCode": "SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050",
                "productName": "Valkey(7.2.11)",
                "productType": {
                    "code": "LINUX",
                    "codeName": "Linux"
                },
                "productDescription": "Rocky Linux 8.10 with Valkey",
                "infraResourceType": {
                    "code": "SW",
                    "codeName": "Software"
                },
                "baseBlockStorageSize": 53687091200,
                "platformType": {
                    "code": "LNX64",
                    "codeName": "Linux 64 Bit"
                },
                "osInformation": "Rocky Linux 8.10 with Valkey (64-bit)",
                "generationCode": "G2",
                "engineVersionCode": "7.2.11"
            }
        ],
        "requestId": "85d5d076-****-****-****-109aff5e430e",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<getCloudCacheImageProductListResponse>
    <requestId>85d5d076-****-****-****-109aff5e430e</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <productList>
        <product>
<productCode>SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050</productCode>
        <productName>Valkey</productName>
        <productType>
          <code>LINUX</code>
          <codeName>Linux</codeName>
        </productType>
        <productDescription>Rocky Linux 8.10 with Valkey</productDescription>
        <infraResourceType>
          <code>SW</code>
          <codeName>Software</codeName>
        </infraResourceType>
        <baseBlockStorageSize>53687091200</baseBlockStorageSize>
        <platformType>
          <code>LNX64</code>
          <codeName>Linux 64 Bit</codeName>
        </platformType>
        <osInformation>Rocky Linux 8.10 with Valkey (64-bit)</osInformation>
        <generationCode>G2</generationCode>
        <engineVersionCode>7.2.11</engineVersionCode>
        </product>
    </productList>
</getCloudCacheImageProductListResponse>

getCloudRedisImageProductList API

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

リクエスト

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

メソッド URI
GET, POST /getCloudRedisImageProductList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象 Cloud DB for Cacheイメージ商品コードリストのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
productCode String Optional Cloud DB for Cacheイメージ商品コードで絞り込み
exclusionProductCode String Optional Cloud DB for Cacheイメージ商品コードを除外して絞り込み
generationCode String Optional サーバの世代コードで絞り込み
  • G2 | G3
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisImageProductList
?regionCode=KR
&productCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
        "getCloudRedisImageProductListResponse": {
            "totalRows": 1,
            "productList": [
                {
                    "productCode": "SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050",
                    "productName": "Redis(7.0.15)",
                    "productType": {
                        "code": "LINUX",
                        "codeName": "Linux"
                    },
                    "productDescription": "CentOS 7.8 with Redis 7.0.15",
                    "infraResourceType": {
                        "code": "SW",
                        "codeName": "Software"
                    },
                    "baseBlockStorageSize": 53687091200,
                    "platformType": {
                        "code": "LNX64",
                        "codeName": "Linux 64 Bit"
                    },
                    "osInformation": "CentOS 7.8 with Redis 7.0.15 (64-bit)",
                    "generationCode": "G2"
                }
            ],
            "requestId": "85d5d076-****-****-****-109aff5e430e",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisImageProductListResponse>
        <requestId>85d5d076-****-****-****-109aff5e430e</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <productList>
            <product>
                <productCode>SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050</productCode>
                <productName>Redis(7.0.15)</productName>
                <productType>
                    <code>LINUX</code>
                    <codeName>Linux</codeName>
                </productType>
                <productDescription>CentOS 7.8 with Redis 7.0.15</productDescription>
                <infraResourceType>
                    <code>SW</code>
                    <codeName>Software</codeName>
                </infraResourceType>
                <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                <platformType>
                    <code>LNX64</code>
                    <codeName>Linux 64 Bit</codeName>
                </platformType>
                <osInformation>CentOS 7.8 with Redis 7.0.15 (64-bit)</osInformation>
                <generationCode>G2</generationCode>
            </product>
        </productList>
    </getCloudRedisImageProductListResponse>