VPC環境で利用できます。
使用可能な Cloud DB for Cacheサーバスペックコードリストを照会します。
Cloud DB for Cache APIは、対応する DBMSの範囲に応じて2つのバージョンを提供しています。
- getCloudCacheProductList API: Valkey、Redis DBMSを利用可能
- getCloudRedisProductList API: Redis DBMSを利用可能
getCloudCacheProductList API
getCloudCacheProductList APIのリクエストおよびレスポンス形式を説明します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET, POST | /getCloudCacheProductList |
リクエストヘッダ
Cloud DB for Cache (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for Cache (VPC)のリクエストヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | 照会対象 Cloud DB for Cacheインスタンスのリージョンコード
|
zoneCode |
String | Optional | ゾーンコードで絞り込み
|
cloudCacheImageProductCode |
String | Required | Cloud DB for Cacheイメージ商品コードで絞り込み |
productCode |
String | Optional | Cloud DB for Cache商品コードで絞り込み
|
exclusionProductCode |
String | Optional | Cloud DB for Cache商品コードを除外して絞り込み
|
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vcache/v2/getCloudCacheProductList
?regionCode=KR
&cloudCacheImageProductCode=SW.VRDS.OS.LNX64.ROCKY.0810.VALKY.B050
&productCode=SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
&exclusionProductCode=SVR.VRDS.STAND.C004.M003.NET.SSD.B050.G002'
--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の場合
{
"getCloudCacheProductListResponse": {
"totalRows": 1,
"productList": [
{
"productCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"productName": "Memory 1.5GB",
"productType": {
"code": "STAND",
"codeName": "Standard"
},
"productDescription": "メモリ 1.5GB",
"infraResourceType": {
"code": "VRDS",
"codeName": "Cloud DB for Cache (VPC)"
},
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"diskType": {
"code": "NET",
"codeName": "ネットワークストレージ"
}
}
],
"requestId": "cc5baf55-****-****-****-97e0cd863759",
"returnCode": "0",
"returnMessage": "success"
}
}
responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<getCloudCacheProductListResponse>
<requestId>cc5baf55-****-****-****-97e0cd863759</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<productList>
<product>
<productCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</productCode>
<productName>Memory 1.5GB</productName>
<productType>
<code>STAND</code>
<codeName>Standard</codeName>
</productType>
<productDescription>メモリ 1.5GB</productDescription>
<infraResourceType>
<code>VRDS</code>
<codeName>Cloud DB for Cache (VPC)</codeName>
</infraResourceType>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
<osMemorySize>2147483648</osMemorySize>
<diskType>
<code>NET</code>
<codeName>ネットワークストレージ</codeName>
</diskType>
</product>
</productList>
</getCloudCacheProductListResponse>
getCloudRedisProductList API
getCloudRedisProductList APIのリクエストおよびレスポンス形式を説明します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET, POST | /getCloudRedisProductList |
リクエストヘッダ
Cloud DB for Cache APIで共通して使用されるヘッダの詳細は、Cloud DB for Cacheのリクエストヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | 照会対象 Cloud DB for Cacheインスタンスのリージョンコード
|
zoneCode |
String | Optional | ゾーンコードで絞り込み
|
cloudRedisImageProductCode |
String | Required | Cloud DB for Cacheイメージ商品コードで絞り込み |
productCode |
String | Optional | Cloud DB for Cache商品コードで絞り込み
|
exclusionProductCode |
String | Optional | Cloud DB for Cache商品コードを除外して絞り込み
|
responseFormatType |
String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisProductList
?regionCode=KR
&cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050
&productCode=SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
&exclusionProductCode=SVR.VRDS.STAND.C004.M003.NET.SSD.B050.G002'
--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の場合{ "getCloudRedisProductListResponse": { "totalRows": 1, "productList": [ { "productCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002", "productName": "Memory 1.5GB", "productType": { "code": "STAND", "codeName": "Standard" }, "productDescription": "メモリ 1.5GB", "infraResourceType": { "code": "VRDS", "codeName": "Cloud DB for Cache (VPC)" }, "cpuCount": 4, "memorySize": 1610612736, "osMemorySize": 2147483648, "diskType": { "code": "NET", "codeName": "Network Storage" } } ], "requestId": "cc5baf55-****-****-****-97e0cd863759", "returnCode": "0", "returnMessage": "success" } } -
responseFormatType=xml(デフォルト)の場合<?xml version="1.0" encoding="UTF-8"?> <getCloudRedisProductListResponse> <requestId>cc5baf55-****-****-****-97e0cd863759</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <totalRows>1</totalRows> <productList> <product> <productCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</productCode> <productName>Memory 1.5GB</productName> <productType> <code>STAND</code> <codeName>Standard</codeName> </productType> <productDescription>メモリ 1.5GB</productDescription> <infraResourceType> <code>VRDS</code> <codeName>Cloud DB for Cache (VPC)</codeName> </infraResourceType> <cpuCount>4</cpuCount> <memorySize>1610612736</memorySize> <osMemorySize>2147483648</osMemorySize> <diskType> <code>NET</code> <codeName>Network Storage</codeName> </diskType> </product> </productList> </getCloudRedisProductListResponse>