getCloudMongoDbInstanceList

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC 환경에서 이용 가능합니다.

개요

Cloud DB for MongoDB 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
regionCode	No	String		- 리전 코드 Cloud DB for MongoDB 인스턴스 리스트가 조회될 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택
zoneCode	No	String		- ZONE 코드 Cloud DB for MongoDB 인스턴스 리스트가 조회될 Zone 결정 가능 zoneCode는 getZoneList 액션을 통해 획득 가능
vpcNo	No	String		- VPC 번호 Cloud DB for MongoDB 인스턴스 리스트가 조회될 VPC 결정 가능 vpcNo는 getCloudMongoDbTargetVpcList 액션을 통해 획득 가능
subnetNo	No	String		- Subnet 번호 Cloud DB for MongoDB 인스턴스 리스트가 조회될 Subnet 결정 가능 SubnetNo는 getCloudMongoDbTargetSubnetList 액션을 통해 획득 가능
cloudMongoDbServiceName	No	String		- Cloud DB for MongoDB 서비스 이름 Cloud DB for MongoDB 서비스 이름으로 필터링하여 검색 가능 cloudMongoDbServiceName은 getCloudMongoDbInstanceList 액션을 통해 획득 가능
cloudMongoDbInstanceNoList	No	List<String>		- Cloud DB for MongoDB 인스턴스 번호 리스트 Cloud DB for MongoDB 인스턴스 번호로 필터링하여 검색 가능 cloudMongoDbInstanceNoList는 getCloudMongoDbInstanceList 액션을 통해 획득 가능 ex) cloudMongoDbInstanceNoList.1=1234&cloudMongoDbInstanceNoList.2=2345
cloudMongoDbServerName	No	String		- Cloud DB for MongoDB 서버 이름 Cloud DB for MongoDB 서버 이름으로 필터링하여 검색 가능 cloudMongoDbServerName은 getCloudMongoDbInstanceList 액션을 통해 획득 가능
cloudMongoDbServerInstanceNoList	No	List<String>		- Cloud DB for MongoDB 서버 인스턴스 번호 리스트 Cloud DB for MongoDB 서버 인스턴스 번호로 필터링하여 검색 가능 cloudMongoDbServerInstanceNoList getCloudMongoDbInstanceList 액션을 통해 획득 가능 ex) cloudMongoDbServerInstanceNoList.1=1234&cloudMongoDbServerInstanceNoList.2=2345
generationCode	No	String		- 서버 세대 코드 Options: G2 \| G3
pageNo	No	Integer	Min: 0	- 페이징된 결과의 페이지 번호 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer	Min: 1	- 페이징 시 보여줄 각 페이지 사이즈 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력시 반드시 입력 필요
responseFormatType	No	String		- 응답 결과의 포맷 타입 Options : xml \| json Default : xml

응답

응답 바디

CloudMongoDbInstanceList

예시

요청 예시

GET {API_URL}/getCloudMongoDbInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***87
&subnetNo=***32
&cloudMongoDbServiceName=test-****
&cloudMongoDbInstanceNoList.1=178****
&cloudMongoDbServerName=test-****
&cloudMongoDbServerInstanceNoList.1=1781***
&generationCode=G2
&pageNo=0
&pageSize=10

응답 예시


<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>
            <generationCode>G2</generationCode>
            <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>

이 문서가 도움이 되었습니까?

What's Next

getCloudMongoDbProductList

개요
요청
응답
예시

태그

Cloud DB for MongoDB