--- title: "getCloudMongoDbInstanceList" slug: "database-vmongodb-getcloudmongodbinstancelist" updated: 2026-09-17T09:57:51Z published: 2026-09-17T09:57: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 VPC環境で利用できます。 Cloud DB for MongoDBインスタンスリストを照会します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET \| POST | /vmongodb/v2/getCloudMongoDbInstanceList | 参考 ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。 ### リクエストヘッダ Cloud DB for MongoDB (VPC) APIで共通して使用されるヘッダの詳細は、[Cloud DB for MongoDB (VPC)のリクエストヘッダ](/docs/ja/database-vmongodb#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `regionCode` | String | Optional | 照会対象の Cloud DB for MongoDBインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) | | `zoneCode` | String | Optional | ゾーンコードでフィルタリング - [getZoneList](/docs/ja/compute-vserver-server-common-getzonelist)を参照 | | `vpcNo` | String | Optional | VPC番号でフィルタリング - [getCloudMssqlTargetVpcList](/docs/ja/database-vmssql-getcloudmssqltargetvpclist)を参照 | | `subnetNo` | String | Optional | Subnet番号でフィルタリング - [getCloudMssqlTargetSubnetList](/docs/ja/database-vmssql-getcloudmssqltargetsubnetlist)を参照 | | `cloudMongoDbServiceName` | String | Optional | Cloud DB for MongoDBサービス名でフィルタリング - [getCloudMongoDbInstanceList](/docs/ja/database-vmongodb-getcloudmongodbinstancelist)を参照 | | `cloudMongoDbInstanceNoList.N` | List[String] | Optional | Cloud DB for MongoDBインスタンス番号でフィルタリング - [getCloudMongoDbInstanceList](/docs/ja/database-vmongodb-getcloudmongodbinstancelist)を参照 - <例> `cloudMongoDbInstanceNoList.1=1234&cloudMongoDbInstanceNoList.2=2345` | | `cloudMongoDbServerName` | String | Optional | Cloud DB for MongoDBサーバ名でフィルタリング - [getCloudMongoDbInstanceList](/docs/ja/database-vmongodb-getcloudmongodbinstancelist)を参照 | | `cloudMongoDbServerInstanceNoList.N` | List[String] | Optional | Cloud DB for MongoDBサーバインスタンス番号でフィルタリング - [getCloudMongoDbInstanceList](/docs/ja/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.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/ja/common-vapidatatype-cloudmongodbinstancelist)をご参照ください。 ### レスポンスステータスコード Cloud DB for MongoDB (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for MongoDB (VPC)のレスポンスステータスコード](/docs/ja/database-vmongodb#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 - `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 ```