DescribeDBInstances
调用DescribeDBInstances接口查询MongoDB实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeDBInstances |
要执行的操作,取值:DescribeDBInstances。 |
PageNumber | Integer | 否 | 1 |
页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Integer | 否 | 30 |
每页记录数,取值: 30、50、100,默认值为30。 |
DBInstanceId | String | 否 | dds-bpxxxxxxxx |
实例ID。 |
ReplicationFactor | String | 否 | 3 |
副本集实例的节点数量,取值:3、5、7。 |
DBInstanceDescription | String | 否 | 测试数据库 |
实例的描述或备注信息。 |
DBInstanceStatus | String | 否 | ACTIVATION |
实例的状态信息,取值详情请参考实例状态表。 |
DBInstanceType | String | 否 | replicate |
实例类型,取值:
|
DBInstanceClass | String | 否 | dds.mongo.mid |
实例规格,取值详情请参考实例规格表。 |
Engine | String | 否 | MongoDB |
数据库引擎,取值为MongoDB。 |
EngineVersion | String | 否 | 4.0 |
实例的数据库版本,取值:3.2、3.4、4.0或4.2。 |
NetworkType | String | 否 | VPC |
实例网络类型,取值:
|
VpcId | String | 否 | vpc-bpxxxxxxxx |
专有网络ID。 |
VSwitchId | String | 否 | vsw-bpxxxxxxxx |
专有网络的交换机ID。 |
ChargeType | String | 否 | PrePaid |
实例付费类型,取值:
|
ZoneId | String | 否 | cn-hangzhou-b |
可用区ID。 |
Tag.N.Key | String | 否 | testdatabase |
实例的标签键。N的取值范围:1~20。最多支持64个字符,不能以 aliyun、acs:、http:// 或者 https:// 开头。 说明 不允许传入空字符串。
|
Tag.N.Value | String | 否 | apitest |
实例的标签值。N的取值范围:1~20。最多支持128个字符,不能以 aliyun、acs:、http:// 或者 https:// 开头。 说明 TagValue可以为空。
|
ExpireTime | String | 否 | 2019-12-26T16:00Z |
实例的到期时间。 |
Expired | String | 否 | true |
实例过期状态,取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | A10B8ECB-0BA0-4EC6-93A5-C65FDEDA07CB |
请求ID。 |
PageNumber | Integer | 1 |
页码。 |
PageSize | Integer | 30 |
每页记录数。 |
TotalCount | Integer | 1 |
查询结果中实例的数量。 |
DBInstances | Array |
实例信息列表。 |
|
ResourceGroupId | String | rg-axxxxxxxx |
资源组ID。 |
DBInstanceId | String | dds-bpxxxxxxxx |
实例ID。 |
DBInstanceDescription | String | 测试数据库 |
实例的描述或备注信息。 |
RegionId | String | cn-hangzhou |
实例所属地域ID。 |
ZoneId | String | cn-hangzhou-b |
实例所属可用区ID。 |
Engine | String | MongoDB |
数据库引擎。 |
EngineVersion | String | 4.0 |
实例数据库版本。 |
DBInstanceClass | String | dds.mongo.mid |
实例规格。 |
DBInstanceStorage | Integer | 20 |
实例存储空间。 |
DBInstanceStatus | String | Running |
实例状态,详情请参见实例状态表。 |
LockMode | String | Unlock |
实例的锁定状态。
|
ChargeType | String | PostPaid |
实例付费类型。
|
NetworkType | String | VPC |
实例网络类型。
|
CreationTime | String | 2018-09-25T06:33:07Z |
实例创建的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
ExpireTime | String | 2019-11-25T16:00Z |
实例到期时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。 |
DBInstanceType | String | sharding |
实例的类型。
|
LastDowngradeTime | String | 2019-03-08 |
实例最后一次降配时间。 |
ReplicationFactor | String | 3 |
实例中节点的个数。 说明 实例类型为副本集实例时返回该参数。
|
DestroyTime | String | 2019-03-05T11:26:02Z |
实例数据销毁时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明
|
VpcAuthMode | String | off |
是否开启了专有网络免密访问功能,返回值:
|
MongosList | Array |
Mongos节点信息列表。 说明 实例类型为分片集群实例时返回该参数。
|
|
NodeId | String | s-bpxxxxxxxx |
Mongos节点ID。 |
NodeDescription | String | 测试mongos节点 |
Mongos节点描述。 |
NodeClass | String | dds.mongos.mid |
Mongos节点规格。 |
ShardList | Array |
Shard节点信息列表。 说明 实例类型为分片集群实例时返回该参数。
|
|
NodeId | String | d-bpxxxxxxxx |
Shard节点ID。 |
NodeDescription | String | 测试shard节点 |
Shard节点描述。 |
NodeClass | String | dds.shard.mid |
Shard节点的实例规格。 |
NodeStorage | Integer | 20 |
Shard节点的存储空间,单位为GB。 |
Tags | Array |
资源标签信息列表。 |
|
Key | String | test |
资源的标签键。 |
Value | String | api |
资源的标签值。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstances
&<公共请求参数>
正常返回示例
XML
格式
<PageNumber>1</PageNumber>
<TotalCount>1</TotalCount>
<PageSize>30</PageSize>
<RequestId>D1FF92B8-3714-4182-BA0B-D04F917F0463</RequestId>
<DBInstances>
<DBInstance>
<ChargeType>PostPaid</ChargeType>
<LockMode>Unlock</LockMode>
<DBInstanceClass>dds.mongo.logic</DBInstanceClass>
<ResourceGroupId>rg-acxxxxxxxx</ResourceGroupId>
<DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
<ZoneId>cn-hangzhou-i</ZoneId>
<MongosList>
<MongosAttribute>
<NodeId>s-bpxxxxxxxx</NodeId>
<NodeClass>dds.mongos.mid</NodeClass>
</MongosAttribute>
<MongosAttribute>
<NodeId>s-bpxxxxxxxx</NodeId>
<NodeClass>dds.mongos.mid</NodeClass>
</MongosAttribute>
</MongosList>
<DBInstanceDescription>testdata</DBInstanceDescription>
<Engine>MongoDB</Engine>
<CreationTime>2019-11-23T03:08:01Z</CreationTime>
<Tags>
</Tags>
<NetworkType>VPC</NetworkType>
<ExpireTime>2999-09-08T16:00Z</ExpireTime>
<DBInstanceType>sharding</DBInstanceType>
<RegionId>cn-hangzhou</RegionId>
<ShardList>
<ShardAttribute>
<NodeId>d-bpxxxxxxxx</NodeId>
<NodeClass>dds.shard.standard</NodeClass>
<NodeStorage>10</NodeStorage>
</ShardAttribute>
<ShardAttribute>
<NodeId>d-bpxxxxxxxx</NodeId>
<NodeClass>dds.shard.standard</NodeClass>
<NodeStorage>10</NodeStorage>
</ShardAttribute>
</ShardList>
<EngineVersion>4.2</EngineVersion>
<DBInstanceStatus>Running</DBInstanceStatus>
</DBInstance>
</DBInstances>
JSON
格式
{
"PageNumber": 1,
"TotalCount": 1,
"PageSize": 30,
"RequestId": "D1FF92B8-3714-4182-BA0B-D04F917F0463",
"DBInstances": {
"DBInstance": [
{
"ChargeType": "PostPaid",
"LockMode": "Unlock",
"DBInstanceClass": "dds.mongo.logic",
"ResourceGroupId": "rg-acxxxxxxxx",
"DBInstanceId": "dds-bpxxxxxxxx",
"ZoneId": "cn-hangzhou-i",
"MongosList": {
"MongosAttribute": [
{
"NodeId": "s-bpxxxxxxxx",
"NodeClass": "dds.mongos.mid"
},
{
"NodeId": "s-bpxxxxxxxx",
"NodeClass": "dds.mongos.mid"
}
]
},
"DBInstanceDescription": "testdata",
"Engine": "MongoDB",
"CreationTime": "2019-11-23T03:08:01Z",
"Tags": {
"Tag": []
},
"NetworkType": "VPC",
"ExpireTime": "2999-09-08T16:00Z",
"DBInstanceType": "sharding",
"RegionId": "cn-hangzhou",
"ShardList": {
"ShardAttribute": [
{
"NodeId": "d-bpxxxxxxxx",
"NodeClass": "dds.shard.standard",
"NodeStorage": 10
},
{
"NodeId": "d-bpxxxxxxxx",
"NodeClass": "dds.shard.standard",
"NodeStorage": 10
}
]
},
"EngineVersion": "4.2",
"DBInstanceStatus": "Running"
}
]
}
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论