DescribeDBInstancesOverview
查询一个或多个云数据库MongoDB实例的概览信息
服务地址:
华东1 金融云
输入参数
只看必填
RegionId地域ID
InstanceIds需要查询概览的实例ID
InstanceStatus实例的状态信息
ChargeType实例的付费类型
NetworkType实例的网络类型
EngineVersion实例的引擎版本
InstanceClass实例规格
VpcId专有网络ID
VSwitchId虚拟交换机ID
InstanceType实例类型
ZoneId可用区ID
ResourceGroupId资源组ID
ShowTags是否展示实例标签
请选择布尔值
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 如果您未指定实例的具体信息,则返回当前账号的目标地域下所有实例的概览信息。

  • 该接口返回结果不进行分页。

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
InstanceIdsstring

需要查询概览的实例 ID。展开详情

示例值:dds-bp12c5b040dc****参考取值来源:
    DescribeDBInstances
    CreateDBInstance
InstanceStatusstring

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

示例值:Running
ChargeTypestring

实例的付费类型,取值:展开详情

示例值:PostPaid
NetworkTypestring

实例的网络类型,取值:展开详情

示例值:Classic
EngineVersionstring

实例的引擎版本,取值为 5.04.44.24.03.4

示例值:4.0参考取值来源:
    DescribeAvailableEngineVersion
InstanceClassstring

实例规格。不同类型实例的规格分别请参见:展开详情

示例值:dds.mongo.2xlarge参考取值来源:
    CreateDBInstance
    DescribeDBInstances
VpcIdstring

专有网络 ID。

示例值:vpc-bp1nme44gek34slfc****
VSwitchIdstring

虚拟交换机 ID。

示例值:vsw-bp1e7clcw529l773d****
InstanceTypestring

实例类型,取值: 展开详情

示例值:replicate参考取值来源:
    DescribeDBInstances
ZoneIdstring

可用区 ID。

示例值:cn-hangzhou-b
ResourceGroupIdstring

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

示例值:rg-acfmyiu4ekp****
ShowTagsboolean

是否展示实例标签,默认值 false。

示例值:false

返回参数

字段名称字段详情
TotalCountstring

查询结果中实例的数量。

示例值:1
RequestIdstring

请求 ID。

示例值:52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
DBInstancesarray<object>

实例信息列表。

变更历史
变更时间变更内容概要操作
2025-01-02
新增请求参数ShowTags
2022-01-11
新增OpenAPI,查询实例的概览信息
2021-12-16
新增OpenAPI,查询实例的概览信息