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

VPC環境で利用できます。

Cloud DB for MongoDBインスタンスリストを照会します。

構文

getCloudMongoDbInstanceList構文は次の通りです。

./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>]

オプション

getCloudMongoDbInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getCloudMongoDbInstanceListの必須オプションです。

オプション タイプ 必須の有無 説明
--pageSize Integer Conditional ページごとの項目数
  • 1~N
  • pageNo入力時、必ず入力

任意オプション

getCloudMongoDbInstanceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--zoneCode String Optional ゾーンコード
--vpcNo String Optional VPC番号
--subnetNo String Optional Subnet番号
--cloudMongoDbServiceName String Optional Cloud DB for MongoDBサービス名
--cloudMongoDbInstanceNoList List Optional Cloud DB for MongoDBインスタンス番号リスト
  • スペースで区切って複数入力可能 (例: --cloudMongoDbInstanceNoList 1234 2345)
--cloudMongoDbServerName String Optional Cloud DB for MongoDBサーバ名
--cloudMongoDbServerInstanceNoList List Optional Cloud DB for MongoDBサーバインスタンス番号リスト
  • スペースで区切って複数入力可能 (例: --cloudMongoDbServerInstanceNoList 1234 2345)
--generationCode String Optional サーバの世代コード
  • G2 | G3
--pageNo Integer Optional ページ番号
  • 0~N

共通オプション

vmongodbコマンドで共通して使用するオプションについては、Cloud DB for MongoDB (VPC)のオプションをご参照ください。

例

Cloud DB for MongoDBインスタンスリストの照会リクエストが成功すると、各インスタンスの構成情報と状態が返されます。

コマンド

コマンドの例は次の通りです。

./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

出力

出力の例は次の通りです。

{
  "getCloudMongoDbInstanceListResponse": {
    "totalRows": 1,
    "cloudMongoDbInstanceList": [
      {
        "cloudMongoDbInstanceNo": "34567890",
        "cloudMongoDbServiceName": "mongodb-01",
        "cloudMongoDbInstanceStatusName": "running",
        "cloudMongoDbInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created状態"
        },
        "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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMongoDbServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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"
  }
}
事業者登録番号: 129-86-31394 通信販売業申告番号:第2009-京畿城南-0510号
代表取締役: キム・ユウォン アドレス: 13561 京畿道 城南市 盆唐区 仏亭路6 グリーンファクトリー, 17~26F お客様センターの代表電話: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.