首页 云数据库 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 LIST
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/*
  • MongoDB
    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

实例的到期时间。

2019-12-26T16:00Z
DBInstanceStatus string

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

Running
DBInstanceType string

实例类型,取值说明:

  • sharding:分片集群实例。

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

  • serverless:Serverless实例。

sharding
DBInstanceClass string

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

dds.mongo.mid
Engine string

数据库引擎,取值为MongoDB

MongoDB
EngineVersion string

数据库版本号,取值:

  • 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
Key string

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

  • 不能以aliyunacs:http://https://开头。
  • 最多支持64个字符。
  • 不允许传入空字符串。
testdatabase
Value string

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

  • 不能以aliyunacs:、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 array

实例信息列表。

object
CreationTime string

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

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

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

  • PrePaid:预付费,包年包月。
  • PostPaid:按量付费。
PrePaid
Tags array

资源标签信息列表。

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

数据库版本号,取值:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
4.2
MongosList array

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 array

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时间)。

说明
  • 包年包月实例,到期15天后会被释放,数据也会被删除且无法恢复。
  • 按量付费实例,欠费超过24小时会被锁定,持续欠费15天会被释放,数据也被删除且无法恢复。
  • 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

    示例

    正常返回示例

    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"
          }
        ]
      }
    }

    错误码

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

    变更历史

    变更时间 变更内容概要 操作
    2021-12-27 API 内部配置变更,不影响调用
    变更项 变更内容
    API 内部配置变更,不影响调用
    2021-12-27 OpenAPI 返回结构发生变更
    变更项 变更内容
    出参 OpenAPI 返回结构发生变更
    阿里云首页 云数据库 MongoDB 版 相关技术圈