getCloudMongoDbTargetSubnetList

Prev Next

VPC環境で利用できます。

Cloud DB for MongoDBで使用可能な Subnetリストを照会します。

リクエスト

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

メソッド URI
GET, POST /getCloudMongoDbTargetSubnetList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Subnetのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
vpcNo String Required VPC番号でフィルタリング
cloudMongoDbImageProductCode String Required Cloud DB for MongoDBイメージ商品コードでフィルタリング
isPublic Boolean Optional Public Subnetかどうかでフィルタリング
  • true (デフォルト) | false
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/getCloudMongoDbTargetSubnetList
?regionCode=KR
&vpcNo=59***
&cloudMongoDbImageProductCode=SW.VMGDB.LNX64.CNTOS.0708.MNGDB.5025.CE.B050
&isPublic=true
&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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

  • responseFormetType=jsonの場合

    {
        "getCloudMongoDbTargetSubnetListResponse": {
            "totalRows": 1,
            "targetSubnetList": [
                {
                    "subnetNo": "140***",
                    "subnetName": "***-subnet2",
                    "vpcNo": "59***",
                    "vpcName": "***-vpc",
                    "zoneCode": "KR-1",
                    "subnet": "**.**.**.**/**",
                    "isPublic": true,
                    "createdDate": "2024-03-29T11:20:34+0900"
                }
            ],
            "requestId": "32252c00-****-****-****-c2405ed6bdae",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMongoDbTargetSubnetListResponse>
        <requestId>32252c00-****-****-****-c2405ed6bdae</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <targetSubnetList>
            <targetSubnet>
                <subnetNo>140***</subnetNo>
                <subnetName>***-subnet2</subnetName>
                <vpcNo>59***</vpcNo>
                <vpcName>***-vpc</vpcName>
                <zoneCode>KR-1</zoneCode>
                <subnet>**.**.**.**/**</subnet>
                <isPublic>true</isPublic>
                <createdDate>2024-03-29T11:20:34+0900</createdDate>
            </targetSubnet>
        </targetSubnetList>
    </getCloudMongoDbTargetSubnetListResponse>