查询一个或多个云数据库MongoDB实例的概览信息。
接口说明
-
如果您未指定实例的具体信息，则返回当前账号的目标地域下所有实例的概览信息。
-
该接口返回结果不进行分页。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dds:DescribeDBInstancesOverview |
get |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
否 |
实例规格。不同类型实例的规格分别请参见： 说明
Serverless 实例不需要传入该参数。 |
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**** |
| ShowTags |
boolean |
否 |
是否展示实例标签，默认值 false。 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
实例概览信息。 |
||
| TotalCount |
string |
查询结果中实例的数量。 |
1 |
| RequestId |
string |
请求 ID。 |
52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA |
| DBInstances |
array<object> |
实例信息列表。 |
|
|
object |
实例信息列表。 |
||
| ResourceGroupId |
string |
实例所属资源组 ID。 |
rg-acfm22cdcgc**** |
| CapacityUnit |
string |
实例消耗的读写吞吐量。 说明
|
100 |
| DestroyTime |
string |
实例数据销毁时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
2021-12-10T16:00:00Z |
| DBInstanceType |
string |
实例类型，取值：
|
replicate |
| MongosList |
array<object> |
Mongos 节点信息列表。 说明
实例类型为分片集群实例时返回该参数。 |
|
|
object |
Mongos 节点信息列表。 说明
实例类型为分片集群实例时返回该参数。 |
||
| NodeClass |
string |
Mongos 节点规格。 |
dds.mongos.standard |
| NodeDescription |
string |
Mongos 节点描述。 |
测试mongos节点 |
| NodeId |
string |
Mongos 节点 ID。 |
s-bp10e3b0d02f**** |
| DBInstanceId |
string |
实例 ID。 |
dds-bp12c5b040dc**** |
| NetworkType |
string |
实例网络类型，取值：
|
VPC |
| LastDowngradeTime |
string |
实例最后一次降配时间。 |
2021-05-08 |
| DBInstanceStorage |
integer |
实例的存储空间大小，单位为 GB。 |
20 |
| Tags |
array<object> |
实例的标签信息。 |
|
|
object |
实例的标签信息。 |
||
| Value |
string |
实例的标签值。N 的取值范围为 1~20。
|
apitest |
| Key |
string |
实例的标签键。N 的取值范围为 1~20。
|
testdatabase |
| Engine |
string |
数据库引擎，取值为 MongoDB。 |
MongoDB |
| DBInstanceDescription |
string |
实例的描述或备注信息。 |
测试数据库 |
| EngineVersion |
string |
实例的数据库版本。 |
4.2 |
| DBInstanceStatus |
string |
实例的状态信息，取值详情请参见实例状态表。 |
Running |
| ZoneId |
string |
实例所属可用区。 |
cn-hangzhou-i |
| ReplicationFactor |
string |
实例中节点的个数。 说明
实例类型为副本集实例时返回该参数。 |
3 |
| DBInstanceClass |
string |
实例规格。不同类型实例的规格分别请参见： 说明
Serverless 实例不需要传入该参数。 |
dds.mongo.mid |
| ShardList |
array<object> |
Shard 节点信息列表。 说明
实例类型为分片集群实例时返回该参数。 |
|
|
object |
Shard 节点信息列表。 说明
实例类型为分片集群实例时返回该参数。 |
||
| NodeClass |
string |
Shard 节点的规格。 |
dds.shard.mid |
| NodeDescription |
string |
Shard 节点的描述信息。 |
测试shard节点 |
| ReadonlyReplicas |
integer |
Shard 节点中只读节点的个数。返回值范围：0~5。 |
2 |
| NodeStorage |
integer |
Shard 节点的存储空间，单位为 GB。 |
10 |
| NodeId |
string |
Shard 节点的 ID。 |
d-bp1cac6f2083**** |
| LockMode |
string |
实例的锁定状态。
|
Unlock |
| ChargeType |
string |
实例付费类型，取值：
|
PrePaid |
| VpcAuthMode |
string |
是否开启了专有网络免密访问功能。取值：
|
Open |
| CreationTime |
string |
实例创建的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
2022-01-05T03:18:53Z |
| RegionId |
string |
实例所属地域 ID。 |
cn-hangzhou |
| ExpireTime |
string |
实例到期时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。 |
2022-02-05T16:00Z |
| KindCode |
string |
表示实例的类型。取值：
|
0 |
示例
正常返回示例
JSON格式
{
"TotalCount": "1",
"RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
"DBInstances": [
{
"ResourceGroupId": "rg-acfm22cdcgc****",
"CapacityUnit": "100",
"DestroyTime": "2021-12-10T16:00:00Z",
"DBInstanceType": "replicate",
"MongosList": [
{
"NodeClass": "dds.mongos.standard",
"NodeDescription": "测试mongos节点",
"NodeId": "s-bp10e3b0d02f****"
}
],
"DBInstanceId": "dds-bp12c5b040dc****",
"NetworkType": "VPC",
"LastDowngradeTime": "2021-05-08",
"DBInstanceStorage": 20,
"Tags": [
{
"Value": "apitest",
"Key": "testdatabase"
}
],
"Engine": "MongoDB",
"DBInstanceDescription": "测试数据库",
"EngineVersion": "4.2",
"DBInstanceStatus": "Running",
"ZoneId": "cn-hangzhou-i",
"ReplicationFactor": "3",
"DBInstanceClass": "dds.mongo.mid",
"ShardList": [
{
"NodeClass": "dds.shard.mid",
"NodeDescription": "测试shard节点",
"ReadonlyReplicas": 2,
"NodeStorage": 10,
"NodeId": "d-bp1cac6f2083****"
}
],
"LockMode": "Unlock",
"ChargeType": "PrePaid",
"VpcAuthMode": "Open",
"CreationTime": "2022-01-05T03:18:53Z",
"RegionId": "cn-hangzhou",
"ExpireTime": "2022-02-05T16:00Z",
"KindCode": "0"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。