Get Replica Set/Shard Cluster List - ListUMongoDBInstances

Overview

Get Replica Set/Shard Cluster List

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListUMongoDBInstances`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	No
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
ClusterId	string	Cluster ID	No

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	array[MongodbInstance]	Replica Set ID	No

Field Name	Type	Description Information	Required
Zone	string	Availability Zone	Yes
ClusterId	string	Replica Set/Shard Cluster ID	Yes
Name	string	Replica Set/Sharded Cluster Instance Name	Yes
DBVersion	string	Versions of Mongodb for Replica Set/Sharded Cluster, including MongoDB-3.6, MongoDB-4.2	Yes
ConnectURL	string	Access address of the replica set/sharded cluster	Yes
CreateTime	int	Creation time of replica set/sharded cluster	Yes
ClusterType	string	Cluster Type, ReplicaSet: Replica Set, SharedCluster: Sharded Cluster	Yes
State	string	Replica Set/Sharded Cluster Status Tags: Initing: Initializing, InitFailed: Installation Failed, Starting: Starting, StartFailed: Start Failed, Running: Running, Stopping: Shutting Down, Stopped: Shut Down, StopFailed: Shutdown Failed, Deleting: Deleting, Deleted: Deleted, DeleteFailed: Deletion Failed, Restarting: Restarting, RestartFailed: Restart Failed.	Yes
IPv6ConnectURL	string	Replica Set/Shard Set IPv6 Access Address	No

https://api.surfercloud.com/?Action=ListUMongoDBInstances
&Region=cn-zj
&ProjectId=OEEeTdSt
&ClusterId=PYMePPwV
&ClusterId=RlOyJXoF

{
  "Action": "ListUMongoDBInstancesResponse",
  "ClusterId": "wWvPiKMh",
  "Message": "IToGkbMD",
  "RetCode": 0
}