getCloudMongoDbInstanceList

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|KRS>] \
    [--output <json|xml>]

옵션

getCloudMongoDbInstanceList 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

getCloudMongoDbInstanceList의 필수 옵션입니다.

옵션	타입	필수 여부	설명
`--pageSize`	Integer	Conditional	페이지당 항목 수 `1`~N `pageNo` 입력 시 필수 입력

선택 옵션

getCloudMongoDbInstanceList의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션	타입	필수 여부	설명
`--zoneCode`	String	Optional	존 코드 getZoneList 참조
`--vpcNo`	String	Optional	VPC 번호 getCloudMongoDbTargetVpcList 참조
`--subnetNo`	String	Optional	Subnet 번호 getCloudMongoDbTargetSubnetList 참조
`--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": "34567891",
            "cloudMongoDbServerName": "mg-mongodb-ab001-4r8p",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567892",
            "cloudMongoDbServerName": "mg-mongodb-ab002-4r8q",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567893",
            "cloudMongoDbServerName": "mg-mongodb-c-4r8t",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567894",
            "cloudMongoDbServerName": "mg-mongodb-c-4r8u",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567895",
            "cloudMongoDbServerName": "mg-mongodb-c-4r8v",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567896",
            "cloudMongoDbServerName": "mg-mongodb-mb001-4r8l",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567897",
            "cloudMongoDbServerName": "mg-mongodb-mb001-4r8m",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567898",
            "cloudMongoDbServerName": "mg-mongodb-mb002-4r8n",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567899",
            "cloudMongoDbServerName": "mg-mongodb-mb002-4r8o",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567991",
            "cloudMongoDbServerName": "mg-mongodb-rt-4r8r",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          },
          {
            "cloudMongoDbServerInstanceNo": "34567992",
            "cloudMongoDbServerName": "mg-mongodb-rt-4r8s",
            "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": "98765432",
            "subnetNo": "23456789",
            "zoneCode": "KR-1",
            "memorySize": 4294967296,
            "cpuCount": 2,
            "dataStorageSize": 10737418240
          }
        ]
      }
    ],
    "requestId": "3a8474fb-fd90-42ad-87e1-b6e0ab942fbb",
    "returnCode": "0",
    "returnMessage": "success"
  }
}