Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudMongoDbInstanceList

Prev Next

Available in VPC

Get the list of Cloud DB for MongoDB instances.

Syntax

The getCloudMongoDbInstanceList syntax is as follows:

./ncloud vmongodb getCloudMongoDbInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudMongoDbServiceName <service-name>] \
    [--cloudMongoDbInstanceNoList <instance-no-list>] \
    [--cloudMongoDbServerName <server-name>] \
    [--cloudMongoDbServerInstanceNoList <server-instance-no-list>] \
    [--generationCode <G2|G3>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMongoDbInstanceList.

Required options

The following options are required for getCloudMongoDbInstanceList.

Options Type Required Description
--pageSize Integer Conditional Number of items per page
  • 1-N
  • Required when entering pageNo.

Optional options

These are the optional options for getCloudMongoDbInstanceList. Options that are not specified will use their default values.

Options Type Required Description
--zoneCode String Optional Zone code
--vpcNo String Optional VPC number
--subnetNo String Optional Subnet number
--cloudMongoDbServiceName String Optional Cloud DB for MongoDB service name
--cloudMongoDbInstanceNoList List Optional Cloud DB for MongoDB instance number list
  • You can enter multiple items separated by spaces (e.g., --cloudMongoDbInstanceNoList 1234 2345).
--cloudMongoDbServerName String Optional Cloud DB for MongoDB server name
--cloudMongoDbServerInstanceNoList List Optional Cloud DB for MongoDB server instance number list
  • You can enter multiple items separated by spaces (e.g., --cloudMongoDbServerInstanceNoList 1234 2345).
--generationCode String Optional Server generation code
  • G2 | G3
--pageNo Integer Optional Page number
  • 0-N

Common options

For information about the options common to all vmongodb subcommands, see Cloud DB for MongoDB (VPC) options.

Examples

If the request to retrieve the list of Cloud DB for MongoDB instances is successful, the configuration information and status of each instance are returned.

Command

The command example is as follows:

./ncloud vmongodb getCloudMongoDbInstanceList \
    --zoneCode KR-1 \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudMongoDbServiceName mongodb-01 \
    --cloudMongoDbInstanceNoList 34567890 \
    --cloudMongoDbServerName mg-mongodb-ab001-98eb \
    --cloudMongoDbServerInstanceNoList 34567895 \
    --generationCode G2 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMongoDbInstanceListResponse": {
    "totalRows": 1,
    "cloudMongoDbInstanceList": [
      {
        "cloudMongoDbInstanceNo": "34567890",
        "cloudMongoDbServiceName": "mongodb-01",
        "cloudMongoDbInstanceStatusName": "running",
        "cloudMongoDbInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudMongoDbInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "generationCode": "G2",
        "cloudMongoDbServerInstanceList": [
          {
            "cloudMongoDbServerInstanceNo": "34567895",
            "cloudMongoDbServerName": "mg-mongodb-ab001-98eb",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "AB",
              "codeName": "Arbiter"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567896",
            "cloudMongoDbServerName": "mg-mongodb-ab002-98ec",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "AB",
              "codeName": "Arbiter"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567899",
            "cloudMongoDbServerName": "mg-mongodb-c-98ef",
            "clusterRole": {
              "code": "CONFIG_SERVER",
              "codeName": "Config Server Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "C",
              "codeName": "Config Server"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567900",
            "cloudMongoDbServerName": "mg-mongodb-c-98eg",
            "clusterRole": {
              "code": "CONFIG_SERVER",
              "codeName": "Config Server Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "C",
              "codeName": "Config Server"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567901",
            "cloudMongoDbServerName": "mg-mongodb-c-98eh",
            "clusterRole": {
              "code": "CONFIG_SERVER",
              "codeName": "Config Server Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "C",
              "codeName": "Config Server"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567891",
            "cloudMongoDbServerName": "mg-mongodb-mb001-98e7",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567892",
            "cloudMongoDbServerName": "mg-mongodb-mb001-98e8",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567893",
            "cloudMongoDbServerName": "mg-mongodb-mb002-98e9",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567894",
            "cloudMongoDbServerName": "mg-mongodb-mb002-98ea",
            "clusterRole": {
              "code": "SHARD",
              "codeName": "Shard Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "MB",
              "codeName": "Member"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567897",
            "cloudMongoDbServerName": "mg-mongodb-rt-98ed",
            "clusterRole": {
              "code": "MONGOS",
              "codeName": "Mongos Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "RT",
              "codeName": "Mongos"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567898",
            "cloudMongoDbServerName": "mg-mongodb-rt-98ee",
            "clusterRole": {
              "code": "MONGOS",
              "codeName": "Mongos Cluster Role - Cloud DB for MongoDB"
            },
            "cloudMongoDbServerInstanceStatusName": "running",
            "cloudMongoDbServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "cloudMongoDbServerRole": {
              "code": "RT",
              "codeName": "Mongos"
            },
            "regionCode": "KR",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          }
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
Business Registration Number: 129-86-31394 E-commerce Permit Number:No. 2009-GyeonggiSeongnam-0510
CEO: Kim Yuwon Address: NAVER Green Factory 17th–26th Floors, Buljeong-ro 6, Bundang-gu, Seongnam-si, Gyeonggi-do 13561, Republic of Korea. Customer Support Number: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.