全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 更多
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 智能硬件
云数据库 MongoDB 版

DescribeDBInstances

更新时间:2018-03-21 00:31:40

描述

该接口用于查询实例列表,同时支持副本集实例和分片集群实例。

输入参数

名称类型是否必须描述
ActionString系统规定参数,取值为:DescribeDBInstances。
RegionIdString实例的地域ID,通过函数DescribeRegions查看。
EngineString数据库类型,取值为MongoDB。
DBInstanceTypeString- 所查询的实例类型,sharding:分片集群实例列表。
- replicate:副本集实例列表;默认值:replicate。
PageSizeInteger每页记录数,取值:30/50/100默认值:30。
PageNumberInteger页码,大于0,且不超过Integer的最大值,默认值:1。

返回参数

名称类型描述
公共返回参数详见公共返回参数
DBInstancesList<DBInstance>由DBInstance组成的数组。

DBInstance数据结构

名称类型描述
DBInstanceIdString实例ID。
ReplicationFactorString节点个数,1代表单节点,3代表三节点。
DBInstanceDescriptionString实例描述。
RegionIdString实例所属地域ID。
ZoneIdString实例所属可用区ID。
EngineString数据库类型。
EngineVersionString数据库版本。
DBInstanceClassString实例规格。
DBInstanceStorageInteger磁盘。
DBInstanceStatusString实例状态,参见实例状态表
ChargeTypeString付费类型:
- PrePaid:包年包月。
- PostPaid:按量付费。
NetworkTypeString网络类型:
- Classic:经典网络。
- VPC:VPC网络。
CreationTimeString创建时间,格式:YYYY-MM-DD‘T‘hh:mm:ssZ,如2011-05-30T12:11:4Z。
ExpireTimeString到期时间。
DBInstanceTypeString实例类型,sharding或者replicate。
MongosListList<Mongos>由Mongos组成的数组。
ShardListList<Shard>由Shard组成的数组。
LastDowngradeTimeInteger最后一次降配时间。

Mongos

名称类型描述
NodeIdStringMongos的实例id
NodeDescriptionStringMongos的实例描述
NodeClassStringMongos规格

Shard

名称类型描述
NodeIdStringShard的实例id
NodeDescriptionStringShard的实例描述
NodeClassStringShard规格
NodeStorageIntegerShard磁盘
本文导读目录