查询MongoDB实例列表。
接口说明
该接口默认查询副本集实例(包含单节点实例)列表,即未配置请求参数DBInstanceType时,该参数的默认值为replicate。如果您需要查询分片集群实例列表,请配置DBInstanceType的值为sharding。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dds:DescribeDBInstances | LIST |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 |
地域ID,您可以调用DescribeRegions接口查询地域ID。 |
cn-hangzhou |
PageNumber | integer | 否 |
页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1。 |
1 |
PageSize | integer | 否 |
每页记录数,取值:
|
30 |
DBInstanceId | string | 否 |
实例ID。 |
dds-bp199659b178**** |
ReplicationFactor | string | 否 |
副本集实例的节点数量,取值:
|
3 |
DBInstanceDescription | string | 否 |
实例名称,取值说明:
|
测试数据库 |
ExpireTime | string | 否 |
实例的到期时间。 |
2019-12-26T16:00Z |
DBInstanceStatus | string | 否 |
实例的状态信息,取值详情请参见实例状态表。 |
Running |
DBInstanceType | string | 否 |
实例类型,取值说明:
|
sharding |
DBInstanceClass | string | 否 |
实例规格,取值详情请参见实例规格表。 |
dds.mongo.mid |
Engine | string | 否 |
数据库引擎,取值为MongoDB。 |
MongoDB |
EngineVersion | string | 否 |
数据库版本号,取值:
|
4.0 |
NetworkType | string | 否 |
实例网络类型,取值说明:
|
VPC |
VpcId | string | 否 |
专有网络ID。 |
vpc-bp1n3i15v90el48nx**** |
VSwitchId | string | 否 |
专有网络的交换机ID。 |
vsw-bp1vj604nj5a9zz74**** |
ChargeType | string | 否 |
实例付费类型,取值说明:
|
PrePaid |
ZoneId | string | 否 |
可用区ID,您可以通过调用DescribeRegions接口查询可用区ID。 |
cn-hangzhou-b |
Expired | string | 否 |
实例过期状态,取值说明:
|
true |
ConnectionDomain | string | 否 |
节点的连接地址,您可以通过调用DescribeDBInstanceAttribute接口查询。 |
dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com |
ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmyiu4ekp**** |
Tag | array | 否 |
标签管理。 |
|
object | 否 | |||
Key | string | 否 |
实例的标签键。N的取值范围为1~20。
|
testdatabase |
Value | string | 否 |
实例的标签值。N的取值范围为1~20。
|
apitest |
DBNodeType | string | 否 |
用于筛选标准实例还是测试实例
|
default |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 5,
"RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
"PageSize": 30,
"PageNumber": 1,
"DBInstances": {
"DBInstance": [
{
"CreationTime": "2021-03-25T02:18:00Z",
"ChargeType": "PrePaid",
"Tags": {
"Tag": [
{
"Key": "test",
"Value": "api"
}
]
},
"VpcAuthMode": "Close",
"NetworkType": "Classic",
"LockMode": "Unlock",
"EngineVersion": "4.2",
"MongosList": {
"MongosAttribute": [
{
"NodeClass": "dds.mongos.standard",
"NodeDescription": "测试mongos节点",
"NodeId": "s-bp10e3b0d02f****"
}
]
},
"DBInstanceDescription": "测试数据库",
"ExpireTime": "2021-11-25T16:00Z",
"DBInstanceType": "sharding",
"LastDowngradeTime": "2021-05-08",
"ShardList": {
"ShardAttribute": [
{
"NodeClass": "dds.shard.mid",
"NodeDescription": "测试shard节点",
"NodeStorage": 10,
"NodeId": "d-bp1cac6f2083****",
"ReadonlyReplicas": 2
}
]
},
"DestroyTime": "2021-12-10T16:00:00Z",
"DBInstanceStatus": "Running",
"RegionId": "cn-hangzhou",
"DBInstanceStorage": 20,
"ResourceGroupId": "rg-acfmyiu4ekp****",
"ZoneId": "cn-hangzhou-g",
"DBInstanceId": "dds-bp18b0934e70****",
"DBInstanceClass": "dds.mongo.mid",
"Engine": "MongoDB",
"ReplicationFactor": "3",
"KindCode": "1",
"CapacityUnit": "100",
"StorageType": "local_ssd",
"SecondaryZoneId": "cn-hangzhou-i",
"HiddenZoneId": "cn-hangzhou-h"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2021-12-27 | API 内部配置变更,不影响调用 | |||
|
||||
2021-12-27 | OpenAPI 返回结构发生变更 | |||
|