リクエスト

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

メソッド	URI
GET, POST	/getCloudRedisProductList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	照会対象の Cloud DB for Redisインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`zoneCode`	String	Optional	ゾーンコードでフィルタリング getZoneListを通じて確認
`cloudRedisImageProductCode`	String	Required	Cloud DB for Redisイメージ商品コードでフィルタリング getCloudRedisImageProductListを通じて確認
`productCode`	String	Optional	Cloud DB for Redis商品コードでフィルタリング getCloudRedisProductListを通じて確認
`exclusionProductCode`	String	Optional	Cloud DB for Redis商品コードを除いてフィルタリング getCloudRedisProductListを通じて確認
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

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 Redis (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 Redis (VPC)</codeName>
            </infraResourceType>
            <cpuCount>4</cpuCount>
            <memorySize>1610612736</memorySize>
            <osMemorySize>2147483648</osMemorySize>
            <diskType>
                <code>NET</code>
                <codeName>Network Storage</codeName>
            </diskType>
        </product>
    </productList>
</getCloudRedisProductListResponse>

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Cloud DB for Redis