查询一个或多个云数据库MongoDB实例的概览信息。
接口说明
-
如果您未指定实例的具体信息，则返回当前账号的目标地域下所有实例的概览信息。
-
该接口返回结果不进行分页。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dds:DescribeDBInstancesOverview | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID，您可以调用 DescribeRegions 查询。 | cn-hangzhou |
| InstanceIds | string | 否 | 需要查询概览的实例 ID。 说明
| dds-bp12c5b040dc**** |
| InstanceStatus | string | 否 | 实例的状态信息，取值详情请参见实例状态表。 | Running |
| ChargeType | string | 否 | 实例的付费类型，取值：
| PostPaid |
| NetworkType | string | 否 | 实例的网络类型，取值：
| Classic |
| EngineVersion | string | 否 | 实例的引擎版本，取值为 5.0、4.4、 4.2、4.0或 3.4。 | 4.0 |
| InstanceClass | string | 否 | dds.mongo.2xlarge | |
| VpcId | string | 否 | 专有网络 ID。 | vpc-bp1nme44gek34slfc**** |
| VSwitchId | string | 否 | 虚拟交换机 ID。 | vsw-bp1e7clcw529l773d**** |
| InstanceType | string | 否 | 实例类型，取值：
说明
| replicate |
| ZoneId | string | 否 | 可用区 ID。 | cn-hangzhou-b |
| ResourceGroupId | string | 否 | 资源组 ID。资源组详情请参见查看资源组基本信息。 | rg-acfmyiu4ekp**** |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": "1",
"RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
"DBInstances": [
{
"CreationTime": "2022-01-05T03:18:53Z",
"ExpireTime": "2022-02-05T16:00Z",
"Tags": [
{
"Key": "testdatabase",
"Value": "apitest"
}
],
"LastDowngradeTime": "2021-05-08",
"ShardList": [
{
"NodeClass": "dds.shard.mid",
"NodeDescription": "测试shard节点",
"NodeStorage": 10,
"NodeId": "d-bp1cac6f2083****",
"ReadonlyReplicas": 2
}
],
"DBInstanceType": "replicate",
"DestroyTime": "2021-12-10T16:00:00Z",
"ChargeType": "PrePaid",
"CapacityUnit": "100",
"VpcAuthMode": "Open",
"DBInstanceStatus": "Running",
"NetworkType": "VPC",
"LockMode": "Unlock",
"EngineVersion": "4.2",
"MongosList": [
{
"NodeClass": "dds.mongos.standard",
"NodeDescription": "测试mongos节点",
"NodeId": "s-bp10e3b0d02f****"
}
],
"RegionId": "cn-hangzhou",
"DBInstanceStorage": 20,
"ResourceGroupId": "rg-acfm22cdcgc****",
"ZoneId": "cn-hangzhou-i",
"DBInstanceId": "dds-bp12c5b040dc****",
"DBInstanceClass": "dds.mongo.mid",
"Engine": "MongoDB",
"ReplicationFactor": "3",
"DBInstanceDescription": "测试数据库",
"KindCode": "0"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-01-11 | 新增 OpenAPI | 查看变更详情 |