调用DescribeDBInstances接口查询云数据库MongoDB的实例列表。

该接口默认查询副本集实例(包含单节点实例)列表,即未配置请求参数DBInstanceType时,该参数的默认值为replicate。如果您需要查询分片集群实例列表,请配置DBInstanceType的值为sharding;如果您需要查询Serverless实例列表,请配置DBInstanceType的值为serverless

调试

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

请求参数

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

系统规定参数。取值:DescribeDBInstances

RegionId String cn-hangzhou

地域ID,您可以调用DescribeRegions接口查询地域ID。

PageNumber Integer 1

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

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
DBInstanceId String dds-bp199659b178****

实例ID。

ReplicationFactor String 3

副本集实例的节点数量,取值:

  • 3
  • 5
  • 7
DBInstanceDescription String 测试数据库

实例名称,取值说明:

  • 以中文、英文字母开头。
  • 可以包含数字、中文、英文、下划线(_)和短横线(-)。
  • 长度为2~256个字符。
ExpireTime String 2019-12-26T16:00Z

实例的到期时间。

DBInstanceStatus String Running

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

DBInstanceType String sharding

实例类型,取值说明:

  • sharding:分片集群实例。
  • replicate:默认值,副本集实例和单节点实例。

  • serverless:Serverless实例。

DBInstanceClass String dds.mongo.mid

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

Engine String MongoDB

数据库引擎,取值为MongoDB

EngineVersion String 4.0

数据库版本号,取值:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.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接口查询可用区ID。

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

  • 不能以aliyunacs:http://https://开头。
  • 最多支持64个字符。
  • 不允许传入空字符串。
Tag.N.Value String apitest

实例的标签值。N的取值范围为1~20

  • 不能以aliyunacs:、http://https://开头。
  • 最多支持128个字符。
  • TagValue可以为空。

返回数据

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

查询结果中实例的数量。

RequestId String 0E4FE33F-5510-5758-8FA7-A6672CDE****

请求ID。

PageSize Integer 30

每页记录数。

PageNumber Integer 1

页码。

DBInstances Array of DBInstance

实例信息列表。

DBInstance
CreationTime String 2021-03-25T02:18:00Z

实例创建的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

ChargeType String PrePaid

实例付费类型,取值说明:

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

资源标签信息列表。

Tag
Key String test

资源的标签键。

Value String api

资源的标签值。

VpcAuthMode String Close

是否开启了专有网络免密访问功能,取值说明:

  • Open:开启。
  • Close:关闭。
NetworkType String Classic

实例网络类型,取值说明:

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

实例的锁定状态,取值说明:

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

数据库版本号,取值:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
MongosList Array of MongosAttribute

Mongos节点信息列表。

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

Mongos节点规格。

NodeDescription String 测试mongos节点

Mongos节点描述。

NodeId String s-bp10e3b0d02f****

Mongos节点ID。

DBInstanceDescription String 测试数据库

实例的描述或备注信息。

ExpireTime String 2021-11-25T16:00Z

实例到期时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。

DBInstanceType String sharding

实例类型,取值说明:

  • sharding:分片集群实例。
  • replicate:副本集实例和单节点实例。

  • serverless:Serverless实例。

LastDowngradeTime String 2021-05-08

实例最后一次降配时间。

ShardList Array of ShardAttribute

Shard节点信息列表。

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

Shard节点的实例规格。

NodeDescription String 测试shard节点

Shard节点描述。

NodeStorage Integer 10

Shard节点的存储空间,单位为GB。

NodeId String d-bp1cac6f2083****

Shard节点ID。

ReadonlyReplicas Integer 2

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

DestroyTime String 2021-12-10T16:00:00Z

实例数据销毁时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

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

实例状态,详情请参见实例状态表

RegionId String cn-hangzhou

实例所属地域ID。

DBInstanceStorage Integer 20

实例存储空间。

ResourceGroupId String rg-acfmyiu4ekp****

资源组ID。

ZoneId String cn-hangzhou-g

实例所属可用区ID。

DBInstanceId String dds-bp18b0934e70****

实例ID。

DBInstanceClass String dds.mongo.mid

实例规格。

Engine String MongoDB

数据库引擎。

ReplicationFactor String 3

实例中节点的个数。

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

实例的类型,取值说明:

  • 0:物理机。
  • 1:ECS。
  • 2:DOCKER。
  • 18:k8s新架构实例。
CapacityUnit String 100

实例消耗的读写吞吐量。

说明 当实例类型为Serverless实例时返回该参数。
StorageType String local_ssd

存储类型,取值说明:

  • cloud_essd:ESSD云盘。
  • local_ssd:SSD本地盘。
SecondaryZoneId String cn-hangzhou-i

实现多可用区部署时,实例的备可用区1,取值说明:

  • cn-hangzhou-g:杭州可用区G。
  • cn-hangzhou-h:杭州可用区H。
  • cn-hangzhou-i:杭州可用区I。
  • cn-hongkong-b:香港可用区B。
  • cn-hongkong-c:香港可用区C。
  • cn-hongkong-d:香港可用区D。
  • cn-wulanchabu-a:乌兰察布可用区A。
  • cn-wulanchabu-b:乌兰察布可用区B。
  • cn-wulanchabu-c:乌兰察布可用区C。
  • ap-southeast-1a:新加坡可用区A。
  • ap-southeast-1b:新加坡可用区B。
  • ap-southeast-1c:新加坡可用区C。
  • ap-southeast-5a:雅加达可用区A。
  • ap-southeast-5b:雅加达可用区B。
  • ap-southeast-5c:雅加达可用区C。
  • eu-central-1a:法兰克福可用区A。
  • eu-central-1b:法兰克福可用区B。
  • eu-central-1c:法兰克福可用区C。
说明
  • 当实例为4.4或5.0版本的多可用区副本集实例或分片集群实例时,返回该参数。
  • 目前仅中国站支持返回该参数。
HiddenZoneId String cn-hangzhou-h

实现多可用区部署时,实例的备可用区2,取值说明:

  • cn-hangzhou-g:杭州可用区G。
  • cn-hangzhou-h:杭州可用区H。
  • cn-hangzhou-i:杭州可用区I。
  • cn-hongkong-b:香港可用区B。
  • cn-hongkong-c:香港可用区C。
  • cn-hongkong-d:香港可用区D。
  • cn-wulanchabu-a:乌兰察布可用区A。
  • cn-wulanchabu-b:乌兰察布可用区B。
  • cn-wulanchabu-c:乌兰察布可用区C。
  • ap-southeast-1a:新加坡可用区A。
  • ap-southeast-1b:新加坡可用区B。
  • ap-southeast-1c:新加坡可用区C。
  • ap-southeast-5a:雅加达可用区A。
  • ap-southeast-5b:雅加达可用区B。
  • ap-southeast-5c:雅加达可用区C。
  • eu-central-1a:法兰克福可用区A。
  • eu-central-1b:法兰克福可用区B。
  • eu-central-1c:法兰克福可用区C。
说明
  • 当实例为4.4或5.0版本的多可用区副本集实例或分片集群实例时,返回该参数。
  • 目前仅中国站支持返回该参数。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeDBInstancesResponse>
    <TotalCount>5</TotalCount>
    <RequestId>0E4FE33F-5510-5758-8FA7-A6672CDE****</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <DBInstances>
        <CreationTime>2021-03-25T02:18:00Z</CreationTime>
        <ChargeType>PrePaid</ChargeType>
        <Tags>
            <Key>test</Key>
            <Value>api</Value>
        </Tags>
        <VpcAuthMode>Close</VpcAuthMode>
        <NetworkType>Classic</NetworkType>
        <LockMode>Unlock</LockMode>
        <EngineVersion>4.2</EngineVersion>
        <MongosList>
            <NodeClass>dds.mongos.standard</NodeClass>
            <NodeDescription>测试mongos节点</NodeDescription>
            <NodeId>s-bp10e3b0d02f****</NodeId>
        </MongosList>
        <DBInstanceDescription>测试数据库</DBInstanceDescription>
        <ExpireTime>2021-11-25T16:00Z</ExpireTime>
        <DBInstanceType>sharding</DBInstanceType>
        <LastDowngradeTime>2021-05-08</LastDowngradeTime>
        <ShardList>
            <NodeClass>dds.shard.mid</NodeClass>
            <NodeDescription>测试shard节点</NodeDescription>
            <NodeStorage>10</NodeStorage>
            <NodeId>d-bp1cac6f2083****</NodeId>
            <ReadonlyReplicas>2</ReadonlyReplicas>
        </ShardList>
        <DestroyTime>2021-12-10T16:00:00Z</DestroyTime>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <RegionId>cn-hangzhou</RegionId>
        <DBInstanceStorage>20</DBInstanceStorage>
        <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <DBInstanceId>dds-bp18b0934e70****</DBInstanceId>
        <DBInstanceClass>dds.mongo.mid</DBInstanceClass>
        <Engine>MongoDB</Engine>
        <ReplicationFactor>3</ReplicationFactor>
        <KindCode>1</KindCode>
        <CapacityUnit>100</CapacityUnit>
        <StorageType>local_ssd</StorageType>
    </DBInstances>
</DescribeDBInstancesResponse>

JSON格式

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

{
  "TotalCount" : 5,
  "RequestId" : "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize" : 30,
  "PageNumber" : 1,
  "DBInstances" : {
    "CreationTime" : "2021-03-25T02:18:00Z",
    "ChargeType" : "PrePaid",
    "Tags" : {
      "Key" : "test",
      "Value" : "api"
    },
    "VpcAuthMode" : "Close",
    "NetworkType" : "Classic",
    "LockMode" : "Unlock",
    "EngineVersion" : 4.2,
    "MongosList" : {
      "NodeClass" : "dds.mongos.standard",
      "NodeDescription" : "测试mongos节点",
      "NodeId" : "s-bp10e3b0d02f****"
    },
    "DBInstanceDescription" : "测试数据库",
    "ExpireTime" : "2021-11-25T16:00Z",
    "DBInstanceType" : "sharding",
    "LastDowngradeTime" : "2021-05-08",
    "ShardList" : {
      "NodeClass" : "dds.shard.mid",
      "NodeDescription" : "测试shard节点",
      "NodeStorage" : 10,
      "NodeId" : "d-bp1cac6f2083****",
      "ReadonlyReplicas" : 2
    },
    "DestroyTime" : "2021-12-10T16:00:00Z",
    "DBInstanceStatus" : "Running",
    "RegionId" : "cn-hangzhou",
    "DBInstanceStorage" : 20,
    "ResourceGroupId" : "rg-acfmyiu4ekp****",
    "ZoneId" : "cn-hangzhou-g",
    "DBInstanceId" : "dds-bp18b0934e70****",
    "DBInstanceClass" : "dds.mongo.mid",
    "Engine" : "MongoDB",
    "ReplicationFactor" : 3,
    "KindCode" : 1,
    "CapacityUnit" : 100,
    "StorageType" : "local_ssd"
  }
}

错误码

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