--- title: "getCloudMongoDbInstanceList" slug: "database-vmongodb-getcloudmongodbinstancelist" updated: 2026-09-17T10:05:51Z published: 2026-09-17T10:05:51Z canonical: "api.ncloud-docs.com/database-vmongodb-getcloudmongodbinstancelist" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # getCloudMongoDbInstanceList Available in VPC Get the list of Cloud DB for MongoDB instances. ## Request The following describes the request format for the endpoint. The request format is as follows: | Method | URI | | --- | --- | | GET \| POST | /vmongodb/v2/getCloudMongoDbInstanceList | Note This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console. ### Request headers For information about the headers common to all Cloud DB for MongoDB (VPC) APIs, see [Cloud DB for MongoDB (VPC) request headers](/docs/en/database-vmongodb#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94). ### Request query parameters You can use the following query parameters with your request: | Field | Type | Required | Description | | --- | --- | --- | --- | | `regionCode` | String | Optional | Region code of the Cloud DB for MongoDB instance to view - See [getRegionList](/docs/en/compute-vserver-server-common-getregionlist) - First Region of the `getRegionList` query result (default) | | `zoneCode` | String | Optional | Filter by zone code - See [getZoneList](/docs/en/compute-vserver-server-common-getzonelist) | | `vpcNo` | String | Optional | Filter by VPC number - See [getCloudMssqlTargetVpcList](/docs/en/database-vmssql-getcloudmssqltargetvpclist) | | `subnetNo` | String | Optional | Filter by subnet number - See [getCloudMssqlTargetSubnetList](/docs/en/database-vmssql-getcloudmssqltargetsubnetlist) | | `cloudMongoDbServiceName` | String | Optional | Filter by Cloud DB for MongoDB service name - See [getCloudMongoDbInstanceList](/docs/en/database-vmongodb-getcloudmongodbinstancelist) | | `cloudMongoDbInstanceNoList.N` | List[String] | Optional | Filter by Cloud DB for MongoDB server instance number - See [getCloudMongoDbInstanceList](/docs/en/database-vmongodb-getcloudmongodbinstancelist) - `cloudMongoDbInstanceNoList.1=1234&cloudMongoDbInstanceNoList.2=2345` | | `cloudMongoDbServerName` | String | Optional | Filter by Cloud DB for MongoDB server name - See [getCloudMongoDbInstanceList](/docs/en/database-vmongodb-getcloudmongodbinstancelist) | | `cloudMongoDbServerInstanceNoList.N` | List[String] | Optional | Filter by Cloud DB for MongoDB server instance number - See [getCloudMongoDbInstanceList](/docs/en/database-vmongodb-getcloudmongodbinstancelist) - `cloudMongoDbServerInstanceNoList.1=1234&cloudMongoDbServerInstanceNoList.2=2345` | | `generationCode` | String | Optional | Filter by server generation code - `G2` \| `G3` | | `pageNo` | Integer | Optional | Page numbers in paged results - Page the result values using `pageNo` and `pageSize` - 0 (minimum) | | `pageSize` | Integer | Conditional | Number of results to display on a page - Page the result values using `pageNo` and `pageSize` - Required when entering `pageNo` - 1 - 1000 | | `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/getCloudMongoDbInstanceList ?regionCode=KR &zoneCode=KR-1 &cloudMongoDbServiceName=mongo000 &pageNo=0 &pageSize=1 &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 [CloudMongoDbInstanceList](/docs/en/common-vapidatatype-cloudmongodbinstancelist) for the response body. ### Response status codes For information about the HTTP status codes common to all Cloud DB for MongoDB (VPC) APIs, see [Cloud DB for MongoDB (VPC) response status codes](/docs/en/database-vmongodb#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C). ### Response example The following is a sample response. - If `responseFormatType=json` ``` { "getCloudMongoDbInstanceListResponse": { "totalRows": 1, "cloudMongoDbInstanceList": [ { "cloudMongoDbInstanceNo": "2528****", "cloudMongoDbServiceName": "mongo000", "cloudMongoDbInstanceStatusName": "running", "cloudMongoDbInstanceStatus": { "code": "CREAT", "codeName": "CLOUD DATABASE(VPC) Created State" }, "cloudMongoDbInstanceOperation": { "code": "NULL", "codeName": "CLOUD DATABASE(VPC) Null OP" }, "generationCode": "G2", "cloudMongoDbServerInstanceList": [ { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-c-58l6", "clusterRole": { "code": "CONFIG_SERVER", "codeName": "Config Server Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "C", "codeName": "Config Server" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-c-58l7", "clusterRole": { "code": "CONFIG_SERVER", "codeName": "Config Server Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "C", "codeName": "Config Server" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-c-58l8", "clusterRole": { "code": "CONFIG_SERVER", "codeName": "Config Server Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "C", "codeName": "Config Server" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-mb001-58ky", "clusterRole": { "code": "SHARD", "codeName": "Shard Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "MB", "codeName": "Member" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-mb001-58kz", "clusterRole": { "code": "SHARD", "codeName": "Shard Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "MB", "codeName": "Member" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-mb001-58l0", "clusterRole": { "code": "SHARD", "codeName": "Shard Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "MB", "codeName": "Member" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-mb002-58l1", "clusterRole": { "code": "SHARD", "codeName": "Shard Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "MB", "codeName": "Member" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-mb002-58l2", "clusterRole": { "code": "SHARD", "codeName": "Shard Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "MB", "codeName": "Member" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-mb002-58l3", "clusterRole": { "code": "SHARD", "codeName": "Shard Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "MB", "codeName": "Member" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-rt-58l4", "clusterRole": { "code": "MONGOS", "codeName": "Mongos Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "RT", "codeName": "Mongos" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 }, { "cloudMongoDbServerInstanceNo": "2534****", "cloudMongoDbServerName": "mg-mongo-rt-58l5", "clusterRole": { "code": "MONGOS", "codeName": "Mongos Cluster Role - Cloud DB for MongoDB" }, "cloudMongoDbServerInstanceStatusName": "running", "cloudMongoDbServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMongoDbServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "cloudMongoDbServerRole": { "code": "RT", "codeName": "Mongos" }, "regionCode": "KR", "vpcNo": "59***", "subnetNo": "140***", "zoneCode": "KR-1", "memorySize": 4294967296, "cpuCount": 2, "dataStorageSize": 10737418240 } ] } ], "requestId": "32e6c029-****-****-****-ee1c0fa2c58d", "returnCode": "0", "returnMessage": "success" } } ``` - If `responseFormatType=xml` (default) ``` 32e6c029-****-****-****-ee1c0fa2c58d 0 success 1 2528**** mongo000 running CREAT CLOUD DATABASE(VPC) Created State NULL CLOUD DATABASE(VPC) Null OP G2 2534**** mg-mongo-c-58l6 CONFIG_SERVER Config Server Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP C Config Server KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-c-58l7 CONFIG_SERVER Config Server Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP C Config Server KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-c-58l8 CONFIG_SERVER Config Server Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP C Config Server KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-mb001-58ky SHARD Shard Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP MB Member KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-mb001-58kz SHARD Shard Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP MB Member KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-mb001-58l0 SHARD Shard Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP MB Member KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-mb002-58l1 SHARD Shard Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP MB Member KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-mb002-58l2 SHARD Shard Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP MB Member KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-mb002-58l3 SHARD Shard Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP MB Member KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-rt-58l4 MONGOS Mongos Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP RT Mongos KR 59*** 140*** KR-1 4294967296 2 10737418240 2534**** mg-mongo-rt-58l5 MONGOS Mongos Cluster Role - Cloud DB for MongoDB running RUN CLOUD DATABASE(VPC) Server Running State NOOP CLOUD DATABASE(VPC) Server Null OP RT Mongos KR 59*** 140*** KR-1 4294967296 2 10737418240 ```