DescribeDBInstancesOverview_云数据库 MongoDB 版_API文档

插件下载了解更多
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.

接口说明

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

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

流控信息

请求速率为100/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dds:DescribeDBInstancesOverview
Get
Instance
acs:dds:{#regionId}:{#accountId}:dbinstance/*

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou
InstanceIdsstring

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

示例值:dds-bp12c5b040dc****
InstanceStatusstring

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

示例值:Running
ChargeTypestring

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

示例值:PostPaid
NetworkTypestring

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

示例值:Classic
EngineVersionstring

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

示例值:4.0
InstanceClassstring

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

示例值:dds.mongo.2xlarge
VpcIdstring

专有网络 ID。

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

虚拟交换机 ID。

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

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

示例值:replicate
ZoneIdstring

可用区 ID。

示例值:cn-hangzhou-b
ResourceGroupIdstring

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

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

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

示例值:false

返回参数

字段名称字段详情
TotalCountstring

查询结果中实例的数量。

示例值:1
RequestIdstring

请求 ID。

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

实例信息列表。

返回示例

变更历史

相关示例