getCloudMongoDbTargetSubnetList

Prev Next

Available in VPC

Get the list of subnets available to use in Cloud DB for MongoDB.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET, POST /getCloudMongoDbTargetSubnetList

Request headers

For headers common to all Cloud DB for MongoDB (VPC) APIs, see Cloud DB for MongoDB (VPC) request headers.

Request parameter

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the subnet to view
  • Check through getRegionList
  • First Region of the getRegionList query result (default)
vpcNo String Required Filter by VPC number
cloudMongoDbImageProductCode String Required Filter by Cloud DB for MongoDB image product code
isPublic Boolean Optional Filter by public subnet status
  • true (default) | false
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The following is a sample request.

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}'

Response

The following describes the response format.

Response body

See TargetSubnetList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

  • If 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"
    }
}

  • If responseFormetType=xml (default)

    <?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>