调用DescribeDBInstanceAttribute接口查询云数据库MongoDB实例的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeDBInstanceAttribute |
系统规定参数。取值:DescribeDBInstanceAttribute。 |
| Engine | String | 否 | MongoDB |
数据库引擎,固定取值:MongoDB。 |
| DBInstanceId | String | 是 | dds-bp11483712c1**** |
实例ID。 |
| ResourceGroupId | String | 否 | rg-acfmyiu4ekp**** |
资源组ID。资源组详情请参见查看资源组基本信息。 说明 目前仅中国站支持配置该参数。
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | A935A8EE-A6CC-53DE-98BA-20ABAA7E632B |
请求ID。 |
| DBInstances | Array of DBInstance |
实例详细信息。 |
|
| DBInstance | |||
| CreationTime | String | 2022-01-02T07:43:59Z |
实例的创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
| ReplicaSets | Array of ReplicaSet |
副本集实例信息。 说明 当实例类型为副本集实例时,返回该参数。
|
|
| ReplicaSet | |||
| VSwitchId | String | vpc-bp1jk5vwkcri27qme**** |
交换机ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| ConnectionPort | String | 3717 |
节点的连接端口。 |
| ReplicaSetRole | String | Primary |
节点的角色,取值说明:
|
| ConnectionDomain | String | dds-bp11483712c1****.mongodb.rds.aliyuncs.com |
节点的连接地址。 |
| VPCCloudInstanceId | String | dds-bp11483712c1**** |
实例ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| NetworkType | String | VPC |
网络类型,取值说明:
|
| VPCId | String | vpc-bp1jk5vwkcri27qme**** |
专有网络ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| ReplacateId | String | bls-m**** |
全球多活实例的逻辑ID。 说明 MongoDB当前不支持新购该类型实例,该参数仅适用于老版本全球多活实例。
|
| Tags | Array of Tag |
实例的标签信息列表。 |
|
| Tag | |||
| Key | String | test |
实例的标签键。 |
| Value | String | api |
实例的标签值。 |
| VpcAuthMode | String | Open |
私网免密访问模式,取值说明:
|
| NetworkType | String | VPC |
实例的网络类型,取值说明:
|
| LockMode | String | Unlock |
实例的锁定状态,取值说明:
|
| EngineVersion | String | 4.4 |
数据库版本,取值:
|
| MaxIOPS | Integer | 1000 |
实例最大IOPS。 |
| VPCCloudInstanceIds | String | dds-bp11483712c1**** |
实例ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| MongosList | Array of MongosAttribute |
Mongos节点信息列表。 说明 当实例类型为分片集群实例时,返回该参数。
|
|
| MongosAttribute | |||
| VpcCloudInstanceId | String | s-bp1d8c262a158**** |
Mongos节点的ID。 |
| MaxIOPS | Integer | 800 |
Mongos节点的最大IOPS。 |
| VSwitchId | String | vsw-bp1vj604nj5a9zz74**** |
交换机ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| NodeClass | String | dds.mongos.mid |
Mongos节点的规格。 |
| MaxConnections | Integer | 1000 |
Mongos节点的最大连接数。 |
| Port | Integer | 3717 |
Mongos节点的连接端口。 |
| VPCId | String | vpc-bp1n3i15v90el48nx**** |
专有网络ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| ConnectSting | String | s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
Mongos节点的连接地址。 |
| NodeDescription | String | mongos1 |
Mongos节点的名称。 |
| NodeId | String | s-bp1d8c262a15**** |
Mongos节点的ID。 |
| Status | String | Running |
Mongos节点的状态。具体请参见实例状态表。 |
| ProtocolType | String | mongodb |
实例的访问协议类型,取值说明:
说明 当实例类型为分片集群实例时,返回该参数。
|
| DBInstanceDescription | String | 测试数据库 |
实例名称。 |
| CurrentKernelVersion | String | 5.0.5-20220721143518_0 |
实例当前数据库的小版本号。 |
| DBInstanceReleaseProtection | Boolean | false |
是否开启实例释放保护,取值说明:
|
| ExpireTime | String | 2022-02-05T16:00Z |
包年包月实例的到期时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。 说明 当实例的付费类型为包年包月时返回该参数。
|
| MaintainStartTime | String | 18:00Z |
实例可维护时间段的开始时间,格式为HH:mmZ(UTC时间)。 |
| DBInstanceType | String | replicate |
实例类型,取值说明:
|
| LastDowngradeTime | String | 2022-01-08 |
实例最近一次降配时间。 |
| ShardList | Array of ShardAttribute |
Shard节点信息列表。 说明 当实例类型为分片集群实例时返回该参数。
|
|
| ShardAttribute | |||
| MaxIOPS | Integer | 8000 |
Shard节点的最大IOPS。 |
| ConnectString | String | d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:**** |
Shard节点的连接地址。 |
| NodeClass | String | dds.shard.mid |
Shard节点的规格。 |
| MaxConnections | Integer | 8000 |
Shard节点的最大连接数。 |
| Port | Integer | 3717 |
Shard节点的端口。 |
| NodeDescription | String | testshard |
Shard节点的名称。 |
| NodeId | String | d-bp16e09d9c5d**** |
Shard节点的ID。 |
| NodeStorage | Integer | 10 |
Shard节点的存储空间。 |
| ReadonlyReplicas | Integer | 0 |
Shard节点中只读节点的个数,取值范围为0~5(整数)。 |
| Status | String | Running |
Shard节点的状态,具体请参见实例状态表。 |
| MaintainEndTime | String | 03:00Z |
实例可维护时间段的结束时间,格式为HH:mmZ(UTC时间)。 |
| DBInstanceStatus | String | Running |
实例状态,具体请参见实例状态表。 |
| VPCId | String | vpc-bp1n3i15v90el48nx**** |
专有网络ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| RegionId | String | cn-hangzhou |
实例所属地域ID。 |
| DBInstanceStorage | Integer | 10 |
实例存储空间。 |
| ReplicaSetName | String | mgset-10ace**** |
副本集实例的名称。 说明 当实例类型为副本集实例时,返回该参数。
|
| VSwitchId | String | vsw-bp1oo2a7isyrb8igf**** |
交换机ID。 说明 当实例的网络类型为专有网络时,返回该参数。
|
| StorageEngine | String | WiredTiger |
实例的存储引擎类型。 |
| ConfigserverList | Array of ConfigserverAttribute |
Configserver节点信息列表。 说明 当实例类型为分片集群实例时,返回该参数。
|
|
| ConfigserverAttribute | |||
| MaxIOPS | Integer | 1000 |
Configserver节点的最大IOPS。 |
| ConnectString | String | dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com |
Configserver节点的连接地址。 |
| NodeClass | String | dds.cs.mid |
Configserver节点的规格。 |
| MaxConnections | Integer | 1000 |
Configserver节点的最大连接数。 |
| Port | Integer | 3717 |
Configserver节点的端口。 |
| NodeDescription | String | testConfigserver |
Configserver节点的名称。 |
| NodeId | String | dds-bp11483712c1****-cs |
Configserver节点ID。 |
| NodeStorage | Integer | 20 |
Configserver节点的存储空间。 |
| Status | String | Running |
ConfigServer节点的状态。具体请参见实例状态表。 |
| ResourceGroupId | String | rg-acfmyiu4ekp**** |
实例所属资源组ID。 说明 目前仅中国站支持返回该参数。
|
| ZoneId | String | cn-hangzhou-b |
实例所属可用区ID。 |
| MaxConnections | Integer | 500 |
实例最大连接数。 |
| DBInstanceId | String | dds-bp11483712c1**** |
实例ID。 |
| DBInstanceClass | String | dds.mongo.mid |
实例规格。 |
| Engine | String | MongoDB |
数据库引擎。 |
| ReadonlyReplicas | String | 1 |
实例的只读节点个数。 |
| ReplicationFactor | String | 3 |
实例节点数量。 说明 实例类型为副本集实例时,返回该参数。
|
| KindCode | String | 1 |
实例的类型,取值说明:
|
| CapacityUnit | String | 100 |
实例消耗的读写吞吐量。 |
| ChargeType | String | PostPaid |
实例的付费类型,取值说明:
|
| SecondaryZoneId | String | cn-hangzhou-i |
实现多可用区部署时,实例的备可用区1,取值说明:
说明
|
| HiddenZoneId | String | cn-hangzhou-h |
实现多可用区部署时,实例的备可用区2,取值说明:
说明
|
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDBInstanceAttribute
&Engine=MongoDB
&DBInstanceId=dds-bp11483712c1****
&ResourceGroupId=rg-acfmyiu4ekp****
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstanceAttributeResponse>
<RequestId>A935A8EE-A6CC-53DE-98BA-20ABAA7E632B</RequestId>
<DBInstances>
<CreationTime>2022-01-02T07:43:59Z</CreationTime>
<ReplicaSets>
<VSwitchId>vpc-bp1jk5vwkcri27qme****</VSwitchId>
<ConnectionPort>3717</ConnectionPort>
<ReplicaSetRole>Primary</ReplicaSetRole>
<ConnectionDomain>dds-bp11483712c1****.mongodb.rds.aliyuncs.com</ConnectionDomain>
<VPCCloudInstanceId>dds-bp11483712c1****</VPCCloudInstanceId>
<NetworkType>VPC</NetworkType>
<VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
</ReplicaSets>
<ReplacateId>bls-m****</ReplacateId>
<Tags>
<Key>test</Key>
<Value>api</Value>
</Tags>
<VpcAuthMode>Open</VpcAuthMode>
<NetworkType>VPC</NetworkType>
<LockMode>Unlock</LockMode>
<EngineVersion>4.4</EngineVersion>
<MaxIOPS>1000</MaxIOPS>
<VPCCloudInstanceIds>dds-bp11483712c1****</VPCCloudInstanceIds>
<MongosList>
<VpcCloudInstanceId>s-bp1d8c262a158****</VpcCloudInstanceId>
<MaxIOPS>800</MaxIOPS>
<VSwitchId>vsw-bp1vj604nj5a9zz74****</VSwitchId>
<NodeClass>dds.mongos.mid</NodeClass>
<MaxConnections>1000</MaxConnections>
<Port>3717</Port>
<VPCId>vpc-bp1n3i15v90el48nx****</VPCId>
<ConnectSting>s-bp1d8c262a15****.mongodb.rds.aliyuncs.com</ConnectSting>
<NodeDescription>mongos1</NodeDescription>
<NodeId>s-bp1d8c262a15****</NodeId>
<Status>Running</Status>
</MongosList>
<ProtocolType>mongodb</ProtocolType>
<DBInstanceDescription>测试数据库</DBInstanceDescription>
<CurrentKernelVersion>5.0.5-20220721143518_0</CurrentKernelVersion>
<DBInstanceReleaseProtection>false</DBInstanceReleaseProtection>
<ExpireTime>2022-02-05T16:00Z</ExpireTime>
<MaintainStartTime>18:00Z</MaintainStartTime>
<DBInstanceType>replicate</DBInstanceType>
<LastDowngradeTime>2022-01-08</LastDowngradeTime>
<ShardList>
<MaxIOPS>8000</MaxIOPS>
<ConnectString>d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****</ConnectString>
<NodeClass>dds.shard.mid</NodeClass>
<MaxConnections>8000</MaxConnections>
<Port>3717</Port>
<NodeDescription>testshard</NodeDescription>
<NodeId>d-bp16e09d9c5d****</NodeId>
<NodeStorage>10</NodeStorage>
<ReadonlyReplicas>0</ReadonlyReplicas>
<Status>Running</Status>
</ShardList>
<MaintainEndTime>03:00Z</MaintainEndTime>
<DBInstanceStatus>Running</DBInstanceStatus>
<VPCId>vpc-bp1n3i15v90el48nx****</VPCId>
<RegionId>cn-hangzhou</RegionId>
<DBInstanceStorage>10</DBInstanceStorage>
<ReplicaSetName>mgset-10ace****</ReplicaSetName>
<VSwitchId>vsw-bp1oo2a7isyrb8igf****</VSwitchId>
<StorageEngine>WiredTiger</StorageEngine>
<ConfigserverList>
<MaxIOPS>1000</MaxIOPS>
<ConnectString>dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com</ConnectString>
<NodeClass>dds.cs.mid</NodeClass>
<MaxConnections>1000</MaxConnections>
<Port>3717</Port>
<NodeDescription>testConfigserver</NodeDescription>
<NodeId>dds-bp11483712c1****-cs</NodeId>
<NodeStorage>20</NodeStorage>
<Status>Running</Status>
</ConfigserverList>
<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
<ZoneId>cn-hangzhou-b</ZoneId>
<MaxConnections>500</MaxConnections>
<DBInstanceId>dds-bp11483712c1****</DBInstanceId>
<DBInstanceClass>dds.mongo.mid</DBInstanceClass>
<Engine>MongoDB</Engine>
<ReadonlyReplicas>1</ReadonlyReplicas>
<ReplicationFactor>3</ReplicationFactor>
<KindCode>1</KindCode>
<CapacityUnit>100</CapacityUnit>
<ChargeType>PostPaid</ChargeType>
<SecondaryZoneId>cn-hangzhou-i</SecondaryZoneId>
<HiddenZoneId>cn-hangzhou-h</HiddenZoneId>
</DBInstances>
</DescribeDBInstanceAttributeResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "A935A8EE-A6CC-53DE-98BA-20ABAA7E632B",
"DBInstances" : [ {
"CreationTime" : "2022-01-02T07:43:59Z",
"ReplicaSets" : [ {
"VSwitchId" : "vpc-bp1jk5vwkcri27qme****",
"ConnectionPort" : "3717",
"ReplicaSetRole" : "Primary",
"ConnectionDomain" : "dds-bp11483712c1****.mongodb.rds.aliyuncs.com",
"VPCCloudInstanceId" : "dds-bp11483712c1****",
"NetworkType" : "VPC",
"VPCId" : "vpc-bp1jk5vwkcri27qme****"
} ],
"ReplacateId" : "bls-m****",
"Tags" : [ {
"Key" : "test",
"Value" : "api"
} ],
"VpcAuthMode" : "Open",
"NetworkType" : "VPC",
"LockMode" : "Unlock",
"EngineVersion" : "4.4",
"MaxIOPS" : 1000,
"VPCCloudInstanceIds" : "dds-bp11483712c1****",
"MongosList" : [ {
"VpcCloudInstanceId" : "s-bp1d8c262a158****",
"MaxIOPS" : 800,
"VSwitchId" : "vsw-bp1vj604nj5a9zz74****",
"NodeClass" : "dds.mongos.mid",
"MaxConnections" : 1000,
"Port" : 3717,
"VPCId" : "vpc-bp1n3i15v90el48nx****",
"ConnectSting" : "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
"NodeDescription" : "mongos1",
"NodeId" : "s-bp1d8c262a15****",
"Status" : "Running"
} ],
"ProtocolType" : "mongodb",
"DBInstanceDescription" : "测试数据库",
"CurrentKernelVersion" : "5.0.5-20220721143518_0",
"DBInstanceReleaseProtection" : false,
"ExpireTime" : "2022-02-05T16:00Z",
"MaintainStartTime" : "18:00Z",
"DBInstanceType" : "replicate",
"LastDowngradeTime" : "2022-01-08",
"ShardList" : [ {
"MaxIOPS" : 8000,
"ConnectString" : "d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****",
"NodeClass" : "dds.shard.mid",
"MaxConnections" : 8000,
"Port" : 3717,
"NodeDescription" : "testshard",
"NodeId" : "d-bp16e09d9c5d****",
"NodeStorage" : 10,
"ReadonlyReplicas" : 0,
"Status" : "Running"
} ],
"MaintainEndTime" : "03:00Z",
"DBInstanceStatus" : "Running",
"VPCId" : "vpc-bp1n3i15v90el48nx****",
"RegionId" : "cn-hangzhou",
"DBInstanceStorage" : 10,
"ReplicaSetName" : "mgset-10ace****",
"VSwitchId" : "vsw-bp1oo2a7isyrb8igf****",
"StorageEngine" : "WiredTiger",
"ConfigserverList" : [ {
"MaxIOPS" : 1000,
"ConnectString" : "dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com",
"NodeClass" : "dds.cs.mid",
"MaxConnections" : 1000,
"Port" : 3717,
"NodeDescription" : "testConfigserver",
"NodeId" : "dds-bp11483712c1****-cs",
"NodeStorage" : 20,
"Status" : "Running"
} ],
"ResourceGroupId" : "rg-acfmyiu4ekp****",
"ZoneId" : "cn-hangzhou-b",
"MaxConnections" : 500,
"DBInstanceId" : "dds-bp11483712c1****",
"DBInstanceClass" : "dds.mongo.mid",
"Engine" : "MongoDB",
"ReadonlyReplicas" : "1",
"ReplicationFactor" : "3",
"KindCode" : "1",
"CapacityUnit" : "100",
"ChargeType" : "PostPaid",
"SecondaryZoneId" : "cn-hangzhou-i",
"HiddenZoneId" : "cn-hangzhou-h"
} ]
}
错误码
访问错误中心查看更多错误码。