调用DescribeDBInstances接口查询MongoDB实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDBInstances

系统规定参数。取值：DescribeDBInstances。

RegionId String 否 cn-hangzhou

地域ID，您可以调用DescribeRegions查询。

PageNumber Integer 否 1

页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。

PageSize Integer 否 30

每页记录数，取值： 30、50、100，默认值为30。

DBInstanceId String 否 dds-bp199659b178****

实例ID。
ReplicationFactor String 否 3

副本集实例的节点数量，取值：3、5、7。

DBInstanceDescription String 否 测试数据库

实例的描述或备注信息。
ExpireTime String 否 2019-12-26T16:00Z

实例的到期时间。
DBInstanceStatus String 否 Running

实例的状态信息，取值详情请参见实例状态表。

DBInstanceType String 否 replicate

实例类型，取值：

  • sharding：分片集群实例。
  • replicate：副本集实例和单节点实例，默认值为replicate。
  • serverless：Serverless实例。（仅中国站支持该种实例类型。）
DBInstanceClass String 否 dds.mongo.mid

实例规格，取值详情请参见实例规格表。

Engine String 否 MongoDB

数据库引擎，取值为MongoDB。

EngineVersion String 否 4.0

数据库版本号。取值：3.2、3.4、4.0、4.2或4.4。

说明 当前仅中国站支持4.4。
NetworkType String 否 VPC

实例网络类型，取值：

  • Classic：经典网络。
  • VPC：VPC网络。
VpcId String 否 vpc-bp1n3i15v90el48nx****

专有网络ID。
VSwitchId String 否 vsw-bp1vj604nj5a9zz74****

专有网络的交换机ID。
ChargeType String 否 PrePaid

实例付费类型，取值：

  • PrePaid：预付费，包年包月。
  • PostPaid：按量付费。
ZoneId String 否 cn-hangzhou-b

可用区ID，您可以通过DescribeRegions查询可用的可用区。

Expired String 否 true

实例过期状态，取值：

  • true：已过期。
  • false：未过期。
ConnectionDomain String 否 dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com

节点的连接地址，您可以调用DescribeDBInstanceAttribute查询。

ResourceGroupId String 否 rg-acfmyiu4ekp****

资源组ID。
Tag.N.Key String 否 testdatabase

实例的标签键。N的取值范围：1~20。最多支持64个字符，不能以aliyun、acs:、http://或者https://开头。

说明 不允许传入空字符串。
Tag.N.Value String 否 apitest

实例的标签值。N的取值范围：1~20。最多支持128个字符，不能以aliyun、acs:、http://或者https://开头。

说明 TagValue可以为空。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

查询结果中实例的数量。
RequestId String A65A6C54-D9E2-52B9-8804-53D22E61****

请求ID。
PageSize Integer 30

每页记录数。
PageNumber Integer 1

页码。
DBInstances Array of DBInstance

实例信息列表。
DBInstance
CreationTime String 2018-09-25T06:33:07Z

实例创建的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

ChargeType String PostPaid

实例付费类型。

  • PrePaid：预付费，包年包月。
  • PostPaid：按量付费。
Tags Array of Tag

资源标签信息列表。
Tag
Key String test

资源的标签键。
Value String api

资源的标签值。
VpcAuthMode String Close

是否开启了专有网络免密访问功能，返回值：

  • Open：开启。
  • Close：关闭。
NetworkType String VPC

实例网络类型。

  • Classic：经典网络。
  • VPC：专有网络。
LockMode String Unlock

实例的锁定状态。

  • Unlock：正常。
  • ManualLock：手动触发锁定。
  • LockByExpiration：实例过期自动锁定。
  • LockByRestoration：实例回滚前自动锁定。
  • LockByDiskQuota：实例空间满自动锁定。
  • Released：实例已释放。此时实例无法进行解锁，只能使用备份数据重新创建新实例，重建时间较长，请耐心等待。
EngineVersion String 4.0

实例数据库版本。
MongosList Array of MongosAttribute

Mongos节点信息列表。

说明 实例类型为分片集群实例时返回该参数。
MongosAttribute
NodeClass String dds.mongos.mid

Mongos节点规格。
NodeDescription String 测试mongos节点

Mongos节点描述。
NodeId String s-bp18e6d84ae3****

Mongos节点ID。
DBInstanceDescription String 测试数据库

实例的描述或备注信息。
ExpireTime String 2019-11-25T16:00Z

实例到期时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。

DBInstanceType String sharding

实例类型，取值：

  • sharding：分片集群实例。
  • replicate：副本集实例和单节点实例。
  • serverless：Serverless实例。（仅中国站支持该种实例类型。）
LastDowngradeTime String 2019-03-08

实例最后一次降配时间。
ShardList Array of ShardAttribute

Shard节点信息列表。

说明 实例类型为分片集群实例时返回该参数。
ShardAttribute
NodeClass String dds.shard.mid

Shard节点的实例规格。
NodeDescription String 测试shard节点

Shard节点描述。
NodeStorage Integer 20

Shard节点的存储空间，单位为GB。
NodeId String d-bp14ec73d7bd****

Shard节点ID。
ReadonlyReplicas Integer 1

Shard节点中只读节点的个数。返回值范围：0~5。

说明 当前仅中国站支持本参数。
DestroyTime String 2019-03-05T11:26:02Z

实例数据销毁时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明
  • 包年包月实例，到期7天后会被释放，数据也会被删除且无法恢复。
  • 按量付费实例，欠费超过24小时会被锁定，持续欠费7天会被释放，数据也被删除且无法恢复。
DBInstanceStatus String Running

实例状态，详情请参见实例状态表。

RegionId String cn-hangzhou

实例所属地域ID。
DBInstanceStorage Integer 20

实例存储空间。
ResourceGroupId String rg-acfmyiu4ekp****

资源组ID。
ZoneId String cn-hangzhou-b

实例所属可用区ID。
DBInstanceId String dds-bp11483712c1****

实例ID。
DBInstanceClass String dds.mongo.mid

实例规格。
Engine String MongoDB

数据库引擎。
ReplicationFactor String 3

实例中节点的个数。

说明 实例类型为副本集实例时返回该参数。
KindCode String 1

表示实例的类型。取值：

  • 0：物理机
  • 1：ECS
  • 2：DOCKER
  • 18：k8s新架构实例

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstances
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstancesResponse>
    <TotalCount>0</TotalCount>
    <RequestId>A65A6C54-D9E2-52B9-8804-53D22E61****</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <DBInstances>
    </DBInstances>
</DescribeDBInstancesResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 0,
  "RequestId" : "A65A6C54-D9E2-52B9-8804-53D22E61****",
  "PageSize" : 30,
  "PageNumber" : 1,
  "DBInstances" : {
    "DBInstance" : [ ]
  }
}

错误码

访问错误中心查看更多错误码。