调用DescribeDBInstancesOverview接口查询一个或多个云数据库MongoDB实例的概览信息。

  • 如果您未指定实例的具体信息，则返回当前账号的目标地域下所有实例的概览信息。
  • 该接口返回结果不进行分页。

调试

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

请求参数

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

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

RegionId String 是 cn-hangzhou

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

InstanceIds String 否 dds-bp12c5b040dc****

需要查询概览的实例ID。

说明
  • 如果不传入该参数，默认查询当前阿里云账号下的所有实例。
  • 支持传入多个实例ID，实例ID之间以英文逗号（,）分隔。
InstanceStatus String 否 Running

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

ChargeType String 否 PostPaid

实例的付费类型，取值：

  • PrePaid：预付费，包年包月。
  • PostPaid：按量付费。
NetworkType String 否 Classic

实例的网络类型，取值：

  • Classic：经典网络。
  • VPC：VPC网络。
EngineVersion String 否 4.0

实例的引擎版本，取值为 5.0、4.4、 4.2、4.0或 3.4。

InstanceClass String 否 dds.mongo.2xlarge

实例规格。不同类型实例的规格分别请参见：

说明 Serverless实例不需要传入该参数。
VpcId String 否 vpc-bp1nme44gek34slfc****

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

虚拟交换机ID。
InstanceType String 否 replicate

实例类型，取值：

  • sharding：分片集群实例。

  • replicate：副本集实例和单节点实例。

  • serverless：Serverless实例。

说明
  • 请根据实际需求配置，例如您需要查询分片集群实例的概览，则配置该参数的值为sharding。
  • 不配置该参数时，默认查询所有实例的概览。
ZoneId String 否 cn-hangzhou-b

可用区ID。
ResourceGroupId String 否 rg-acfmyiu4ekp****

资源组ID。资源组详情请参见查看资源组基本信息。

返回数据

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

查询结果中实例的数量。
RequestId String 52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA

请求ID。
DBInstances Array of DBInstance

实例信息列表。
CreationTime String 2022-01-05T03:18:53Z

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

ExpireTime String 2022-02-05T16:00Z

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

Tags Array of Tag

实例的标签信息。
Key String testdatabase

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

  • 不能以aliyun、acs:、http://或https://开头。
  • 最多支持64个字符。
  • 不允许传入空字符串。
Value String apitest

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

  • 不能以aliyun、acs:、http://或https://开头。
  • 最多支持128个字符。
  • TagValue可以为空。
LastDowngradeTime String 2021-05-08

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

Shard节点信息列表。

说明 实例类型为分片集群实例时返回该参数。
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。

DBInstanceType String replicate

实例类型，取值：

  • sharding：分片集群实例。

  • replicate：副本集实例和单节点实例。

  • serverless：Serverless实例。

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

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

实例付费类型，取值：

  • PrePaid：预付费，包年包月。
  • PostPaid：按量付费。
CapacityUnit String 100

实例消耗的读写吞吐量。

说明
  • 当实例类型为Serverless实例时返回该参数。
  • 仅中国站支持Serverless实例。
VpcAuthMode String Open

是否开启了专有网络免密访问功能。取值：

  • Open：开启。
  • Close：关闭。
DBInstanceStatus String Running

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

NetworkType String VPC

实例网络类型，取值：

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

实例的锁定状态。

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

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

Mongos节点信息列表。

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

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

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

Mongos节点ID。
RegionId String cn-hangzhou

实例所属地域ID。
DBInstanceStorage Integer 20

实例的存储空间大小。
ResourceGroupId String rg-acfm22cdcgc****

实例所属资源组ID。
ZoneId String cn-hangzhou-i

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

实例ID。
DBInstanceClass String dds.mongo.mid

实例规格。不同类型实例的规格分别请参见：

说明 Serverless实例不需要传入该参数。
Engine String MongoDB

数据库引擎，取值为MongoDB。

ReplicationFactor String 3

实例中节点的个数。

说明 实例类型为副本集实例时返回该参数。
DBInstanceDescription String 测试数据库

实例的描述或备注信息。
KindCode String 0

表示实例的类型。取值：

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

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstancesOverview
&RegionId=cn-hangzhou
&InstanceIds=dds-bp12c5b040dc****
&公共请求参数

正常返回示例

XML格式 

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

<DescribeDBInstancesOverviewResponse>
    <TotalCount>1</TotalCount>
    <RequestId>52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA</RequestId>
    <DBInstances>
        <EngineVersion>4.2</EngineVersion>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <ResourceGroupId>rg-acfm22cdcgc****</ResourceGroupId>
        <ZoneId>cn-hangzhou-i</ZoneId>
        <ReplicationFactor>3</ReplicationFactor>
        <CapacityUnit/>
        <DBInstanceClass>dds.mongo.mid</DBInstanceClass>
        <DBInstanceType>replicate</DBInstanceType>
        <LockMode>Unlock</LockMode>
        <DBInstanceId>dds-bp12c5b040dc****</DBInstanceId>
        <ChargeType>PrePaid</ChargeType>
        <NetworkType>VPC</NetworkType>
        <DBInstanceStorage>20</DBInstanceStorage>
        <CreationTime>2022-01-05T03:18:53Z</CreationTime>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2022-02-05T16:00Z</ExpireTime>
        <KindCode>0</KindCode>
        <Engine>MongoDB</Engine>
        <DBInstanceDescription>测试数据库</DBInstanceDescription>
    </DBInstances>
</DescribeDBInstancesOverviewResponse>

JSON格式 

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

{
  "TotalCount" : 1,
  "RequestId" : "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances" : [ {
    "EngineVersion" : "4.2",
    "DBInstanceStatus" : "Running",
    "ResourceGroupId" : "rg-acfm22cdcgc****",
    "ZoneId" : "cn-hangzhou-i",
    "ReplicationFactor" : "3",
    "CapacityUnit" : "",
    "DBInstanceClass" : "dds.mongo.mid",
    "DBInstanceType" : "replicate",
    "LockMode" : "Unlock",
    "DBInstanceId" : "dds-bp12c5b040dc****",
    "ChargeType" : "PrePaid",
    "NetworkType" : "VPC",
    "DBInstanceStorage" : 20,
    "CreationTime" : "2022-01-05T03:18:53Z",
    "RegionId" : "cn-hangzhou",
    "ExpireTime" : "2022-02-05T16:00Z",
    "KindCode" : 0,
    "Engine" : "MongoDB",
    "DBInstanceDescription" : "测试数据库"
  } ]
}

错误码

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