getCloudMongoDbInstanceList

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 1234 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 1234 2345
pageNo	No	Integer	Min: 0	- ページング結果のページ番号結果値を pageNo、pageSizeを利用してページング処理可能
pageSize	Conditional	Integer	Min: 1	- ページング時に表示する各ページのサイズ結果値を pageNo、pageSizeを利用してページング処理可能 pageNoを入力する際に必ず入力
output	No	String		- レスポンス結果のフォーマットタイプ Options : xml \| json Default : json

レスポンス

レスポンスデータのタイプ

CloudMongoDbInstanceListタイプ

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;

例

呼び出し

ncloud vmongodb getCloudMongoDbInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ****87  --subnetNo ****32 --cloudMongoDbServiceName test-**** --cloudMongoDbInstanceNoList 178**** --cloudMongoDbServerName test--**** --cloudMongoDbServerInstanceNoList 1781*** --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>
            <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>