找不到 API ? 点击 反馈吧
- 创建或克隆实例
- 变更实例配置
- 实例管理
- 续费管理
- 查询实例
- 查询实例中的角色信息及连接信息DescribeReplicaSetRole
- 查询实例的小版本发布日志DescribeKernelReleaseNotes
- 查询实例可升级的版本DescribeAvailableEngineVersion
- 查询MongoDB实例列表DescribeDBInstances
- 查询实例的主备切换日志信息DescribeDBInstanceSwitchLog
- 查询云数据库MongoDB实例的信息DescribeDBInstanceAttribute
- 查询实例的各节点的角色和所属的可用区DescribeRoleZoneInfo
- 查询MongoDB实例是否为自动付费DescribeInstanceAutoRenewalAttribute
- 查询MongoDB实例的运维任务数量DescribeActiveOperationTaskCount
- 查询多个主动运维任务信息DescribeActiveOperationTasks
- 查询运维任务类型和任务数量DescribeActiveOperationTaskType
- 查询实例的概览信息DescribeDBInstancesOverview
- 查询任务中心任务状态的概览信息DescribeHistoryTasksStat
- 查询任务中心的任务信息DescribeHistoryTasks
- 任务中心修改任务信息ModifyTaskInfo
- 修改多个主动运维任务切换时间ModifyActiveOperationTasks
- 资源管理
- 区域管理
- 连接管理
- 标签管理
- 账号管理
- 白名单和安全组
- 密钥
- SSL加密
- 审计日志
- 日志管理
- 性能监控
- 参数管理
- 备份与恢复
- 其它
DescribeDBInstancesOverview
查询一个或多个云数据库MongoDB实例的概览信息
服务地址:
华东1 金融云
参数配置
高级配置
输入参数
只看必填
注意事项
RegionId地域ID
InstanceIds需要查询概览的实例ID
InstanceStatus实例的状态信息
ChargeType实例的付费类型
NetworkType实例的网络类型
EngineVersion实例的引擎版本
InstanceClass实例规格
VpcId专有网络ID
VSwitchId虚拟交换机ID
InstanceType实例类型
ZoneId可用区ID
ResourceGroupId资源组ID
ShowTags是否展示实例标签
请选择布尔值
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
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.0、4.4、 4.2、4.0或 3.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,查询实例的概览信息 |