getCloudMongoDbImageProductList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /getCloudMongoDbImageProductList

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/getCloudMongoDbImageProductList
?regionCode=KR
&productCode=SW.VMGDB.LNX64.CNTOS.0708.MNGDB.5025.CE.B050
&generationCode=G2
&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の場合

    {
        "getCloudMongoDbImageProductListResponse": {
            "totalRows": 1,
            "productList": [
                {
                    "productCode": "SW.VMGDB.LNX64.CNTOS.0708.MNGDB.5025.CE.B050",
                    "productName": "MongoDB 5.0.25 Community Edition",
                    "productType": {
                        "code": "LINUX",
                        "codeName": "Linux"
                    },
                    "productDescription": "CentOS 7.8 with MongoDB 5.0.25 Community Edition",
                    "infraResourceType": {
                        "code": "SW",
                        "codeName": "Software"
                    },
                    "infraResourceDetailType": {
                        "code": "MNGOD",
                        "codeName": "Mongod (Primary&Secondary)"
                    },
                    "baseBlockStorageSize": 53687091200,
                    "platformType": {
                        "code": "LNX64",
                        "codeName": "Linux 64 Bit"
                    },
                    "osInformation": "CentOS 7.8 with MongoDB 5.0.25 Community Edition (64-bit)",
                    "generationCode": "G2",
                    "engineVersionCode": "MongoDB 5.0.25 Community Edition"
                }
            ],
            "requestId": "68dad367-****-****-****-453e3d4190ee",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMongoDbImageProductListResponse>
        <requestId>68dad367-****-****-****-453e3d4190ee</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <productList>
            <product>
                <productCode>SW.VMGDB.LNX64.CNTOS.0708.MNGDB.5025.CE.B050</productCode>
                <productName>MongoDB 5.0.25 Community Edition</productName>
                <productType>
                    <code>LINUX</code>
                    <codeName>Linux</codeName>
                </productType>
                <productDescription>CentOS 7.8 with MongoDB 5.0.25 Community Edition</productDescription>
                <infraResourceType>
                    <code>SW</code>
                    <codeName>Software</codeName>
                </infraResourceType>
                <infraResourceDetailType>
                    <code>MNGOD</code>
                    <codeName>Mongod (Primary&amp;Secondary)</codeName>
                </infraResourceDetailType>
                <baseBlockStorageSize>53687091200</baseBlockStorageSize>
                <platformType>
                    <code>LNX64</code>
                    <codeName>Linux 64 Bit</codeName>
                </platformType>
                <osInformation>CentOS 7.8 with MongoDB 5.0.25 Community Edition (64-bit)</osInformation>
                <generationCode>G2</generationCode>
                <engineVersionCode>MongoDB 5.0.25 Community Edition</engineVersionCode>
            </product>
        </productList>
    </getCloudMongoDbImageProductListResponse>