Skip to Content
云数据库 MongoDB UDB(NVMe)获取副本集/分片集群列表 - ListUMongoDBInstances

获取副本集/分片集群列表 - ListUMongoDBInstances

简介

获取副本集/分片集群列表

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 ListUMongoDBInstancesYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表No
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
ClusterIdstring集群IDNo

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No
DataSetarray[MongodbInstance]副本集IDNo

数据模型

MongodbInstance

字段名类型描述信息必填
Zonestring可用区Yes
ClusterIdstring副本集/分片集群IDYes
Namestring副本集/分片集群实例名称Yes
DBVersionstring副本集/分片集群的Mongodb的版本,包括MongoDB-3.6, MongoDB-4.2Yes
ConnectURLstring副本集/分片集群的访问地址Yes
CreateTimeint副本集/分片集群的创建时间Yes
ClusterTypestring集群类型,ReplicaSet :副本集,SharedCluster:分片集Yes
Statestring副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败。Yes
IPv6ConnectURLstring副本集/分片集IPv6访问地址No

示例

请求示例

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

响应示例

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