AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云数据库 MongoDB 版 开发参考 API参考指南 API目录 查询实例 DescribeDBInstances - 查询MongoDB实例列表

DescribeDBInstances - 查询MongoDB实例列表

更新时间：
产品详情
我的收藏

查询MongoDB实例列表。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeDBInstances

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/*

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

否

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

cn-hangzhou
PageNumber

integer

否

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

1
PageSize

integer

否

每页记录数，取值：

  • 30（默认值）

  • 50

  • 100

30
DBInstanceId

string

否

实例 ID。

dds-bp199659b178****
ReplicationFactor

string

否

副本集实例的节点数量，取值：

  • 3

  • 5

  • 7

3
DBInstanceDescription

string

否

实例名称，取值说明：

  • 以中文、英文字母开头。

  • 可以包含数字、中文、英文、下划线（_）和短横线（-）。

  • 长度为 2~256 个字符。

测试数据库
ExpireTime

string

否

实例的到期时间,格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 用于筛选到期时间小于等于该时间的实例。

2019-12-26T16:00:00Z
DBInstanceStatus

string

否

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

Running
DBInstanceType

string

否

实例类型，取值说明：

  • sharding：分片集群实例。

  • replicate：默认值，副本集实例和单节点实例。

  • serverless：Serverless 实例。

sharding
DBInstanceClass

string

否

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

dds.mongo.mid
Engine

string

否

数据库引擎，取值为 MongoDB。

MongoDB
EngineVersion

string

否

数据库版本号，取值：

  • 7.0

  • 6.0

  • 5.0

  • 4.4

  • 4.2

  • 4.0

  • 3.4

4.0
NetworkType

string

否

实例网络类型，取值说明：

  • Classic：经典网络。

  • VPC：VPC 网络。

VPC
VpcId

string

否

专有网络 ID。

vpc-bp1n3i15v90el48nx****
VSwitchId

string

否

专有网络的交换机 ID。

vsw-bp1vj604nj5a9zz74****
ChargeType

string

否

实例付费类型，取值说明：

  • PrePaid：预付费，包年包月。

  • PostPaid：按量付费。

PrePaid
ZoneId

string

否

可用区 ID，您可以通过调用 DescribeRegions 接口查询可用区 ID。

cn-hangzhou-b
Expired

string

否

实例过期状态，取值说明：

  • true：已过期。

  • false：未过期。

true
ConnectionDomain

string

否

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

dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
ResourceGroupId

string

否

资源组 ID。

rg-acfmyiu4ekp****
Tag

array<object>

否

标签管理。

object

否

Key

string

否

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

  • 不能以aliyun、acs:、http://或https://开头。

  • 最多支持 64 个字符。

  • 不允许传入空字符串。

testdatabase
Value

string

否

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

  • 不能以aliyun、acs:、http://或https://开头。

  • 最多支持 128 个字符。

  • TagValue 可以为空。

apitest
DBNodeType

string

否

用于筛选标准实例还是测试实例

  1. 单节点实例和 dbfs 实例：customized

  2. 标准实例（副本集和分片集群）：standard

  3. 默认（展示全部实例）：default

default

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

查询结果中实例的数量。

5
RequestId

string

请求 ID。

0E4FE33F-5510-5758-8FA7-A6672CDE****
PageSize

integer

每页记录数。

30
PageNumber

integer

页码。

1
DBInstances

object

DBInstance

array<object>

实例信息列表。

array<object>

CreationTime

string

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

2021-03-25T02:18:00Z
ChargeType

string

实例付费类型，取值说明：

  • PrePaid：预付费，包年包月。

  • PostPaid：按量付费。

PrePaid
Tags

object

Tag

array<object>

资源标签信息列表。

object

资源标签信息列表。

Key

string

资源的标签键。

test
Value

string

资源的标签值。

api
VpcAuthMode

string

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

  • Open：开启。

  • Close：关闭。

Close
NetworkType

string

实例网络类型，取值说明：

  • Classic：经典网络。

  • VPC：专有网络。

Classic
LockMode

string

实例的锁定状态，取值说明：

  • Unlock：正常。

  • ManualLock：手动触发锁定。

  • LockByExpiration：实例过期自动锁定。

  • LockByRestoration：实例回滚前自动锁定。

  • LockByDiskQuota：实例空间满自动锁定。

  • Released：实例已释放。此时实例无法进行解锁，只能使用备份数据重新创建新实例，重建时间较长，请耐心等待。

Unlock
EngineVersion

string

数据库版本号，取值：

  • 7.0

  • 6.0

  • 5.0

  • 4.4

  • 4.2

  • 4.0

  • 3.4

4.2
MongosList

object

MongosAttribute

array<object>

Mongos 节点信息列表。

说明

实例类型为分片集群实例时，返回该参数。

object

Mongos 节点信息列表。

说明

实例类型为分片集群实例时，返回该参数。

NodeClass

string

Mongos 节点规格。

dds.mongos.standard
NodeDescription

string

Mongos 节点描述。

测试mongos节点
NodeId

string

Mongos 节点 ID。

s-bp10e3b0d02f****
DBInstanceDescription

string

实例的描述或备注信息。

测试数据库
ExpireTime

string

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

2021-11-25T16:00Z
DBInstanceType

string

实例类型，取值说明：

  • sharding：分片集群实例。

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

  • serverless：Serverless 实例。

sharding
LastDowngradeTime

string

实例最后一次降配时间。

2021-05-08
ShardList

object

ShardAttribute

array<object>

Shard 节点信息列表。

说明

实例类型为分片集群实例时返回该参数。

object

Shard 节点信息列表。

说明

实例类型为分片集群实例时返回该参数。

NodeClass

string

Shard 节点的实例规格。

dds.shard.mid
NodeDescription

string

Shard 节点描述。

测试shard节点
NodeStorage

integer

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

10
NodeId

string

Shard 节点 ID。

d-bp1cac6f2083****
ReadonlyReplicas

integer

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

2
DestroyTime

string

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

说明

  • 包年包月实例，到期后第 16 天计算资源会被释放，数据继续保留 7 天，到期后第 23 天，数据会被删除且无法恢复。

  • 按量付费实例，欠费后第 16 天计算资源会被释放，数据继续保留 7 天，欠费后第 23 天，数据会被删除且无法恢复。

2021-12-10T16:00:00Z
DBInstanceStatus

string

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

Running
RegionId

string

实例所属地域 ID。

cn-hangzhou
DBInstanceStorage

integer

实例存储空间。

20
ResourceGroupId

string

资源组 ID。

rg-acfmyiu4ekp****
ZoneId

string

实例所属可用区 ID。

cn-hangzhou-g
DBInstanceId

string

实例 ID。

dds-bp18b0934e70****
DBInstanceClass

string

实例规格。

dds.mongo.mid
Engine

string

数据库引擎。

MongoDB
ReplicationFactor

string

实例中节点的个数。

说明

实例类型为副本集实例时返回该参数。

3
KindCode

string

实例的类型，取值说明：

  • 0：物理机。

  • 1：ECS。

  • 2：DOCKER。

  • 18：k8s 新架构实例。

1
CapacityUnit

string

实例消耗的读写吞吐量。

说明

当实例类型为 Serverless 实例时返回该参数。

100
StorageType

string

存储类型，取值说明：

  • cloud_essd：ESSD 云盘。

  • local_ssd：SSD 本地盘。

local_ssd
SecondaryZoneId

string

实现多可用区部署时，实例的备可用区 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 版本的多可用区副本集实例或分片集群实例时，返回该参数。

  • 目前仅中国站支持返回该参数。

cn-hangzhou-i
HiddenZoneId

string

实现多可用区部署时，实例的备可用区 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 版本的多可用区副本集实例或分片集群实例时，返回该参数。

  • 目前仅中国站支持返回该参数。

cn-hangzhou-h
BackupRetentionPolicy

integer

备份保留策略，取值如下：

  • 0：实例释放时立即删除该实例的所有备份集。

  • 1：实例释放时会自动备份，长期保留该备份集。

  • 2：实例释放时会自动备份，并长期保留该集群的所有备份集。

1
ReleaseTime

string

实例释放时间。

2024-06-17T07:01Z

示例

正常返回示例

JSON格式

{
  "TotalCount": 5,
  "RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2021-03-25T02:18:00Z",
        "ChargeType": "PrePaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Close",
        "NetworkType": "Classic",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "MongosList": {
          "MongosAttribute": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "测试mongos节点",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "测试数据库",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "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",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "BackupRetentionPolicy": 1,
        "ReleaseTime": "2024-06-17T07:01Z"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeAvailableEngineVersion - 查询实例可升级的版本下一篇：DescribeDBInstanceSwitchLog - 查询实例的主备切换日志信息