getCloudMongoDbProductList

Prev Next

VPC環境で利用できます。

Cloud DB for MongoDBで使用可能な サーバスペックコードリストを照会します。

リクエスト

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

メソッド URI
GET, POST /getCloudMongoDbProductList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Cloud DB for MongoDBインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
zoneCode String Optional ゾーンコードでフィルタリング
cloudMongoDbImageProductCode String Required Cloud DB for MongoDBイメージ商品コードでフィルタリング
productCode String Optional Cloud DB for MongoDB商品コードでフィルタリング
infraResourceDetailTypeCode String Optional Cloud DB for MongoDBのその他のサーバインフラ詳細商品コードでフィルタリング
  • MNGOD | MNGOS | ARBIT | CFGSV
exclusionProductCode String Optional Cloud DB for MongoDB商品コードを除いてフィルタリング
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/getCloudMongoDbProductList
?regionCode=KR
&cloudMongoDbImageProductCode=SW.VMGDB.LNX64.CNTOS.0708.MNGDB.5025.CE.B050
&productCode=SVR.VMGDB.CFGSV.HICPU.C002.M004.NET.SSD.B050.G002
&infraResourceDetailTypeCode=CFGSV
&exclusionProductCode=SVR.VMGDB.MNGOS.HICPU.C004.M008.NET.SSD.B050.G00
&responseFormatType=json'
--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のレスポンスステータスコードをご参照ください。

レスポンス例

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

  • responseFormetType=jsonの場合

    {
        "getCloudMongoDbProductListResponse": {
            "totalRows": 1,
            "productList": [
                {
                    "productCode": "SVR.VMGDB.CFGSV.HICPU.C002.M004.NET.SSD.B050.G002",
                    "productName": "vCPU 2EA, Memory 4GB",
                    "productType": {
                        "code": "HICPU",
                        "codeName": "High CPU"
                    },
                    "productDescription": "vCPU 2個、メモリ 4GB、[SSD]ディスク 50GB",
                    "infraResourceType": {
                        "code": "VMGDB",
                        "codeName": "Cloud DB for MongoDB (VPC)"
                    },
                    "infraResourceDetailType": {
                        "code": "CFGSV",
                        "codeName": "Config Server"
                    },
                    "cpuCount": 2,
                    "memorySize": 4294967296,
                    "diskType": {
                        "code": "NET",
                        "codeName": "Network Storage"
                    }
                }
            ],
            "requestId": "8c34cb60-****-****-****-a39379dea1e7",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMongoDbProductListResponse>
        <requestId>8c34cb60-****-****-****-a39379dea1e7</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <productList>
            <product>
                <productCode>SVR.VMGDB.CFGSV.HICPU.C002.M004.NET.SSD.B050.G002</productCode>
                <productName>vCPU 2EA, Memory 4GB</productName>
                <productType>
                    <code>HICPU</code>
                    <codeName>High CPU</codeName>
                </productType>
                <productDescription>vCPU 2個、メモリ 4GB、[SSD]ディスク 50GB</productDescription>
                <infraResourceType>
                    <code>VMGDB</code>
                    <codeName>Cloud DB for MongoDB (VPC)</codeName>
                </infraResourceType>
                <infraResourceDetailType>
                    <code>CFGSV</code>
                    <codeName>Config Server</codeName>
                </infraResourceDetailType>
                <cpuCount>2</cpuCount>
                <memorySize>4294967296</memorySize>
                <diskType>
                    <code>NET</code>
                    <codeName>Network Storage</codeName>
                </diskType>
            </product>
        </productList>
    </getCloudMongoDbProductListResponse>