--- title: "getCloudMongoDbInstanceList" slug: "database-vmongodb-getcloudmongodbinstancelist" tags: ["Cloud DB for MongoDB"] updated: 2026-10-22T10:47:20Z published: 2026-10-22T10:47:20Z canonical: "api-gov.ncloud-docs.com/database-vmongodb-getcloudmongodbinstancelist" --- > ## Documentation Index > Fetch the complete documentation index at: https://api-gov.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # getCloudMongoDbInstanceList VPC 환경에서 이용 가능합니다. Cloud DB for MongoDB 인스턴스 목록을 조회합니다. ## 요청 요청 형식을 설명합니다. 요청 형식은 다음과 같습니다. | 메서드 | URI | | --- | --- | | GET \| POST | /vmongodb/v2/getCloudMongoDbInstanceList | 참고 가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다. ### 요청 헤더 Cloud DB for MongoDB (VPC) API에서 공통으로 사용하는 헤더에 대한 정보는 [Cloud DB for MongoDB (VPC) 요청 헤더](/docs/database-vmongodb#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오. ### 요청 쿼리 파라미터 요청 쿼리 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `regionCode` | String | Optional | 조회할 Cloud DB for MongoDB 인스턴스의 리전 코드 - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 - `getRegionList` 조회 결과의 첫 번째 리전(기본값) | | `zoneCode` | String | Optional | 존 코드로 필터링 - [getZoneList](/docs/compute-vserver-server-common-getzonelist) 참조 | | `vpcNo` | String | Optional | VPC 번호로 필터링 - [getCloudMssqlTargetVpcList](/docs/database-vmssql-getcloudmssqltargetvpclist) 참조 | | `subnetNo` | String | Optional | Subnet 번호로 필터링 - [getCloudMssqlTargetSubnetList](/docs/database-vmssql-getcloudmssqltargetsubnetlist) 참조 | | `cloudMongoDbServiceName` | String | Optional | Cloud DB for MongoDB 서비스 이름으로 필터링 - [getCloudMongoDbInstanceList](/docs/database-vmongodb-getcloudmongodbinstancelist) 참조 | | `cloudMongoDbInstanceNoList.N` | List[String] | Optional | Cloud DB for MongoDB 인스턴스 번호로 필터링 - [getCloudMongoDbInstanceList](/docs/database-vmongodb-getcloudmongodbinstancelist) 참조 - <예시> `cloudMongoDbInstanceNoList.1=1234&cloudMongoDbInstanceNoList.2=2345` | | `cloudMongoDbServerName` | String | Optional | Cloud DB for MongoDB 서버 이름으로 필터링 - [getCloudMongoDbInstanceList](/docs/database-vmongodb-getcloudmongodbinstancelist) 참조 | | `cloudMongoDbServerInstanceNoList.N` | List[String] | Optional | Cloud DB for MongoDB 서버 인스턴스 번호로 필터링 - [getCloudMongoDbInstanceList](/docs/database-vmongodb-getcloudmongodbinstancelist) 참조 - <예시> `cloudMongoDbServerInstanceNoList.1=1234&cloudMongoDbServerInstanceNoList.2=2345` | | `generationCode` | String | Optional | 서버 세대 코드로 필터링 - `G2` \| `G3` | | `pageNo` | Integer | Optional | 페이징 처리된 결과의 페이지 번호 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - 0 (최소) | | `pageSize` | Integer | Conditional | 한 페이지에 보여줄 결과 개수 - `pageNo`, `pageSize`를 이용하여 페이징 처리 - `pageNo` 입력 시 필수 입력 - 1~1000 | | `responseFormatType` | String | Optional | 응답 결과의 형식 - `xml` (기본값) \| `json` | ### 요청 예시 요청 예시는 다음과 같습니다. ``` curl --location --request GET 'https://ncloud.apigw.gov-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}' ``` ## 응답 응답 형식을 설명합니다. ### 응답 바디 응답 바디는 [CloudMongoDbInstanceList](/docs/common-vapidatatype-cloudmongodbinstancelist)를 참조해 주십시오. ### 응답 상태 코드 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/api-call-lgc-errorhandling)를 참조해 주십시오. ### 응답 예시 응답 예시는 다음과 같습니다. - `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" } } ``` - `responseFormatType=xml` (기본값) 일 때 ``` 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 ```