getCloudMongoDbInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Overview

Querying a list of Cloud DB for MongoDB instances

Requests

Request parameters

Parameter name	Requirement status	Type	Restrictions	Description
regionCode	No	String		- Region code Sets the region from which a list of Cloud DB for MongoDB instances is to be queried regionCode can be obtained via the getRegionList action Default: selects the first region of the getRegionList query results
zoneCode	No	String		- Zone code Sets the zone from which a list of Cloud DB for MongoDB instances is to be queried zoneCode can be obtained via the getZoneList action
vpcNo	No	String		- VPC number Sets the VPC from which a list of Cloud DB for MongoDB instances is to be queried vpcNo can be obtained via the getCloudMongoDbTargetVpcList action
subnetNo	No	String		- Subnet number Sets the subnet from which a list of Cloud DB for MongoDB instances is to be queried SubnetNo can be obtained via the getCloudMongoDbTargetSubnetList action
cloudMongoDbServiceName	No	String		- Cloud DB for MongoDB service name Query can be filtered by Cloud DB for MongoDB service name cloudMongoDbServiceName can be obtained via the getCloudMongoDbInstanceList action
cloudMongoDbInstanceNoList	No	List<String>		- Cloud DB for MongoDB instance number list Query can be filtered by Cloud DB for MongoDB instance number cloudMongoDbInstanceNoList can be obtained via the getCloudMongoDbInstanceList action E.g., cloudMongoDbInstanceNoList 1234 2345
cloudMongoDbServerName	No	String		- Cloud DB for MongoDB server name Query can be filtered by Cloud DB for MongoDB server name cloudMongoDbServerName can be obtained via the getCloudMongoDbInstanceList action
cloudMongoDbServerInstanceNoList	No	List<String>		- Cloud DB for MongoDB server instance number list Query can be filtered by Cloud DB for MongoDB server instance number cloudMongoDbServerInstanceNoList can be obtained via the getCloudMongoDbInstanceList action ex) cloudMongoDbServerInstanceNoList 1234 2345
pageNo	No	Integer	Min: 0	- Page number of paged result Paging can be handled using pageNo and pageSize
pageSize	Conditional	Integer	Min: 1	- Size of each page to be displayed when paging Paging can be handled using pageNo and pageSize It must be entered when entering pageNo
output	No	String		- Format type of the response result Options : xml \| json Default : json

Responses

Response data type

CloudMongoDbInstanceList type

CloudMongoDbInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudMongoDbInstance> cloudMongoDbInstanceList = new ArrayList<>();

CloudMongoDbInstance
private String cloudMongoDbInstanceNo;
private String cloudMongoDbServiceName;
private String cloudMongoDbInstanceStatusName;
private CommonCode cloudMongoDbInstanceStatus;
private CommonCode cloudMongoDbInstanceOperation;
private String engineVersion;
private CommonCode licence;
private Integer backupFileRetentionPeriod;
private String backupTime;
private String cloudMongoDbImageProductCode;
private AccessControlGroupNoList accessControlGroupNoList;
private Integer shardCount;
private CommonCode compress;
private CommonCode clusterType;
private Integer memberPort;
private Integer arbiterPort;
private Integer mongosPort;
private Integer configPort;
private Date createDate;
private List<CloudMongoDbInstance> cloudMongoDbServerInstanceList;

AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();

CloudMongoDbServerInstance
private String cloudMongoDbServerInstanceNo;
private String cloudMongoDbServerName;
private CommonCode clusterRole;
private String cloudMongoDbServerInstanceStatusName;
private CommonCode cloudMongoDbServerInstanceStatus;
private CommonCode cloudMongoDbServerInstanceOperation;
private CommonCode cloudMongoDbServerRole;
private String regionCode;
private String vpcNo;
private String subnetNo;
private Date createDate;
private Date uptime;
private String zoneCode;
private String privateDomain;
private String publicDomain;
private Long memorySize;
private Integer cpuCount;
private Long dataStorageSize;
private Long usedDataStorageSize;
private String cloudMongoDbProductCode;
private String replicaSetName;
private CommonCode dataStorageType;

Examples

Call

ncloud vmongodb getCloudMongoDbInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ****87  --subnetNo ****32 --cloudMongoDbServiceName test-**** --cloudMongoDbInstanceNoList 178**** --cloudMongoDbServerName test--**** --cloudMongoDbServerInstanceNoList 1781*** --pageNo 0 --pageSize 10

Responses

<getCloudMongoDbInstanceListResponse>
    <requestId>bb5d1f02-604c-453c-adb1-d644b309b91f</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMongoDbInstanceList>
        <cloudMongoDbInstance>
            <cloudMongoDbInstanceNo>178***</cloudMongoDbInstanceNo>
            <cloudMongoDbServiceName>test-****</cloudMongoDbServiceName>
            <cloudMongoDbInstanceStatusName>running</cloudMongoDbInstanceStatusName>
            <cloudMongoDbInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudMongoDbInstanceStatus>
            <cloudMongoDbInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudMongoDbInstanceOperation>
            <cloudMongoDbServerInstanceList>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-c-eim</cloudMongoDbServerName>
                    <clusterRole>
                        <code>CONFIG_SERVER</code>
                        <codeName>Config Server Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>C</code>
                        <codeName>Config Server</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-c-ein</cloudMongoDbServerName>
                    <clusterRole>
                        <code>CONFIG_SERVER</code>
                        <codeName>Config Server Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>C</code>
                        <codeName>Config Server</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-c-eio</cloudMongoDbServerName>
                    <clusterRole>
                        <code>CONFIG_SERVER</code>
                        <codeName>Config Server Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>C</code>
                        <codeName>Config Server</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-mb001-eie</cloudMongoDbServerName>
                    <clusterRole>
                        <code>SHARD</code>
                        <codeName>Shard Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>MB</code>
                        <codeName>Member</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-mb001-eif</cloudMongoDbServerName>
                    <clusterRole>
                        <code>SHARD</code>
                        <codeName>Shard Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>MB</code>
                        <codeName>Member</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-mb001-eig</cloudMongoDbServerName>
                    <clusterRole>
                        <code>SHARD</code>
                        <codeName>Shard Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>MB</code>
                        <codeName>Member</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-mb002-eih</cloudMongoDbServerName>
                    <clusterRole>
                        <code>SHARD</code>
                        <codeName>Shard Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>MB</code>
                        <codeName>Member</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-mb002-eii</cloudMongoDbServerName>
                    <clusterRole>
                        <code>SHARD</code>
                        <codeName>Shard Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>MB</code>
                        <codeName>Member</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-mb002-eij</cloudMongoDbServerName>
                    <clusterRole>
                        <code>SHARD</code>
                        <codeName>Shard Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>MB</code>
                        <codeName>Member</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-rt-eik</cloudMongoDbServerName>
                    <clusterRole>
                        <code>MONGOS</code>
                        <codeName>Mongos Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>RT</code>
                        <codeName>Mongos</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
                <cloudMongoDbServerInstance>
                    <cloudMongoDbServerInstanceNo>1781***</cloudMongoDbServerInstanceNo>
                    <cloudMongoDbServerName>mg-178****-rt-eil</cloudMongoDbServerName>
                    <clusterRole>
                        <code>MONGOS</code>
                        <codeName>Mongos Cluster Role - Cloud DB For MongoDB</codeName>
                    </clusterRole>
                    <cloudMongoDbServerInstanceStatusName>running</cloudMongoDbServerInstanceStatusName>
                    <cloudMongoDbServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMongoDbServerInstanceStatus>
                    <cloudMongoDbServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMongoDbServerInstanceOperation>
                    <cloudMongoDbServerRole>
                        <code>RT</code>
                        <codeName>Mongos</codeName>
                    </cloudMongoDbServerRole>
                    <regionCode>KR</regionCode>
                    <vpcNo>***87</vpcNo>
                    <subnetNo>***32</subnetNo>
                    <zoneCode>KR-1</zoneCode>
                    <memorySize>4294967296</memorySize>
                    <cpuCount>2</cpuCount>
                    <dataStorageSize>10737418240</dataStorageSize>
                </cloudMongoDbServerInstance>
            </cloudMongoDbServerInstanceList>
        </cloudMongoDbInstance>
    </cloudMongoDbInstanceList>
</getCloudMongoDbInstanceListResponse>

Was this article helpful?

What's Next

getCloudMongoDbProductList

Table of contents

Overview
Requests
Responses
Examples