DescribeDBInstanceAttribute - 云数据库 MongoDB

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDBInstanceAttribute	系统规定参数。取值：DescribeDBInstanceAttribute。
RegionId	String	否	cn-hangzhou	地域ID，您可以调用DescribeRegions查询。
Engine	String	否	MongoDB	数据库引擎，取值：MongoDB。
DBInstanceId	String	是	dds-bp11483712c1****	实例ID。
ResourceGroupId	String	否	rg-acfmyiu4ekp****	资源组ID。

返回数据


名称	类型	示例值	描述
RequestId	String	7D65FDCF-089B-5631-89C8-70C69DAE****	请求ID。
DBInstances	Array of DBInstance		实例详情信息列表。
DBInstance
CreationTime	String	2018-11-21T05:10:00Z	实例创建的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
ReplicaSets	Array of ReplicaSet		副本集实例信息。说明当实例类型为副本集实例时，返回该参数。
ReplicaSet
VSwitchId	String	vsw-bp1oo2a7isyrb8igf****	节点的专有网络中交换机ID。
ConnectionPort	String	3717	节点的连接端口。
ReplicaSetRole	String	Primary	节点的角色。 Primary：主节点。 Secondary：从节点。
ConnectionDomain	String	dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com	节点的连接地址。
VPCCloudInstanceId	String	dds-bp1ea17b41ab****	专有网络实例ID。说明网络类型为专有网络时，返回该参数。
NetworkType	String	VPC	节点的网络类型。 Classic：经典网络。 VPC：专有网络。
VPCId	String	vpc-bp1vwnn14rqpyiczj****	节点的专有网络ID。
ReplacateId	String	bls-m****	全球多活实例的逻辑ID。说明 MongoDB当前不支持新购该类型实例，该参数仅适用于老版本全球多活实例。
ChargeType	String	PostPaid	实例的付费类型。 PrePaid：预付费，包年包月。 PostPaid：后付费，按量付费。
Tags	Array of Tag		实例的标签信息列表。
Tag
Key	String	test	实例的标签键。
Value	String	api	实例的标签值。
VpcAuthMode	String	Open	内网免密访问模式。 Open：内网免密访问处于开启状态。 Close：内网免密访问处于关闭状态，需要使用密码访问。 NotSupport ：不支持该功能。
NetworkType	String	VPC	实例的网络类型。 Classic：经典网络。 VPC：专有网络。
LockMode	String	Unlock	实例的锁定状态。 Unlock：正常，没有被锁定。 ManualLock：手动触发锁定。 LockByExpiration：实例过期自动锁定。 LockByRestoration：实例回滚前自动锁定。 LockByDiskQuota：实例空间满自动锁定。 Released：实例已释放。
EngineVersion	String	4.2	数据库版本。
MaxIOPS	Integer	1000	实例最大IOPS。
VPCCloudInstanceIds	String	dds-bp1ea17b41ab****	实例的专有网络实例ID。
MongosList	Array of MongosAttribute		Mongos节点信息列表。说明当实例类型为分片集群实例时返回该参数。
MongosAttribute
VpcCloudInstanceId	String	s-bp18e6d84ae3****	Mongos节点的专有网络实例ID。
MaxIOPS	Integer	800	Mongos节点的最大IOPS。
VSwitchId	String	vsw-bp1vj604nj5a9zz74****	Mongos节点的交换机VSwitchID。
NodeClass	String	dds.mongos.mid	Mongos节点规格。
MaxConnections	Integer	1000	Mongos节点的最大连接数。
Port	Integer	3717	Mongos节点连接端口。
VPCId	String	vpc-bp1n3i15v90el48nx****	Mongos节点的专有网络VPC ID。
ConnectSting	String	s-bp1a23593e64****.mongodb.rds.aliyuncs.com	Mongos节点连接地址。
NodeDescription	String	mongos1	Mongos节点名称。
NodeId	String	s-bp1a23593e64****	Mongos节点ID。
Status	String	Running	Mongos节点的状态。详情请参见实例状态表。
ProtocolType	String	mongodb	实例的访问协议类型。返回值： mongodb：MongoDB协议 dynamodb：DynamoDB协议
DBInstanceDescription	String	分片集群_dtstest1	实例名称。
CurrentKernelVersion	String	mongodb_20210625_3.0.35	实例当前数据库的小版本号。
DBInstanceReleaseProtection	Boolean	false	是否开启了实例释放保护。返回值： true：开启 false：关闭
ExpireTime	String	2019-04-08T16:00Z	包年包月实例的到期时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。说明当实例的付费类型为包年包月时返回该参数。
MaintainStartTime	String	02:00Z	实例可维护时间段的开始时间，格式为HH:mmZ（UTC时间）。
DBInstanceType	String	replicate	实例类型。 replicate：副本集实例。 sharding：分片集群实例。
LastDowngradeTime	String	2019-03-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	表示实例的类型。取值： 0：物理机 1：ECS 2：DOCKER 18：k8s新架构实例
CapacityUnit	String	100	实例消耗的读写吞吐量。说明当实例类型为Serverless实例时返回该参数。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=dds-bp11483712c1****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceAttributeResponse>
    <RequestId>7D65FDCF-089B-5631-89C8-70C69DAE****</RequestId>
    <DBInstances>
        <DBInstance>
            <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
            <CapacityUnit/>
            <DBInstanceType>sharding</DBInstanceType>
            <StorageEngine>WiredTiger</StorageEngine>
            <ReplicaSets>
            </ReplicaSets>
            <MaintainEndTime>22:00Z</MaintainEndTime>
            <DBInstanceId>dds-bp11483712c1****</DBInstanceId>
            <MongosList>
                <MongosAttribute>
                    <ConnectSting>s-bp18e6d84ae3****.mongodb.rds.aliyuncs.com</ConnectSting>
                    <Status>Running</Status>
                    <NodeClass>dds.mongos.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>1000</MaxConnections>
                    <VPCId>vpc-bp1n3i15v90el48nx****</VPCId>
                    <VSwitchId>vsw-bp1vj604nj5a9zz74****</VSwitchId>
                    <Port>3717</Port>
                    <NodeId>s-bp18e6d84ae3****</NodeId>
                    <VpcCloudInstanceId>s-bp18e6d84ae3****</VpcCloudInstanceId>
                    <MaxIOPS>800</MaxIOPS>
                </MongosAttribute>
                <MongosAttribute>
                    <ConnectSting>s-bp1a23593e64****.mongodb.rds.aliyuncs.com</ConnectSting>
                    <Status>Running</Status>
                    <NodeClass>dds.mongos.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>1000</MaxConnections>
                    <VPCId>vpc-bp1n3i15v90el48nx****</VPCId>
                    <VSwitchId>vsw-bp1vj604nj5a9zz74****</VSwitchId>
                    <Port>3717</Port>
                    <NodeId>s-bp1a23593e64****</NodeId>
                    <VpcCloudInstanceId>s-bp1a23593e64****</VpcCloudInstanceId>
                    <MaxIOPS>800</MaxIOPS>
                </MongosAttribute>
            </MongosList>
            <NetworkType>VPC</NetworkType>
            <DBInstanceDescription>分片集群_dtstest1</DBInstanceDescription>
            <MaintainStartTime>18:00Z</MaintainStartTime>
            <Engine>MongoDB</Engine>
            <Tags>
            </Tags>
            <DBInstanceReleaseProtection>false</DBInstanceReleaseProtection>
            <EngineVersion>4.0</EngineVersion>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ZoneId>cn-hangzhou-k</ZoneId>
            <MaxConnections>200</MaxConnections>
            <VPCId>vpc-bp1n3i15v90el48nx****</VPCId>
            <DBInstanceClass>dds.mongo.logic</DBInstanceClass>
            <VSwitchId>vsw-bp1vj604nj5a9zz74****</VSwitchId>
            <ShardList>
                <ShardAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.shard.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>8000</MaxConnections>
                    <ReadonlyReplicas>0</ReadonlyReplicas>
                    <NodeId>d-bp14ec73d7bd****</NodeId>
                    <NodeStorage>10</NodeStorage>
                    <ConnectString/>
                    <MaxIOPS>8000</MaxIOPS>
                </ShardAttribute>
                <ShardAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.shard.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>8000</MaxConnections>
                    <ReadonlyReplicas>0</ReadonlyReplicas>
                    <NodeId>d-bp16e09d9c5d****</NodeId>
                    <NodeStorage>10</NodeStorage>
                    <ConnectString/>
                    <MaxIOPS>8000</MaxIOPS>
                </ShardAttribute>
            </ShardList>
            <LockMode>Unlock</LockMode>
            <MaxIOPS>800</MaxIOPS>
            <ChargeType>PostPaid</ChargeType>
            <VpcAuthMode>Close</VpcAuthMode>
            <ProtocolType>mongodb</ProtocolType>
            <CurrentKernelVersion>mongodb_20210625_3.0.35</CurrentKernelVersion>
            <CreationTime>2021-07-20T11:20:01Z</CreationTime>
            <ConfigserverList>
                <ConfigserverAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.cs.mid</NodeClass>
                    <NodeDescription/>
                    <NodeId>dds-bp11483712c1****-cs</NodeId>
                    <NodeStorage>20</NodeStorage>
                    <ConnectString/>
                </ConfigserverAttribute>
            </ConfigserverList>
            <RegionId>cn-hangzhou</RegionId>
            <KindCode>0</KindCode>
        </DBInstance>
    </DBInstances>
</DescribeDBInstanceAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7D65FDCF-089B-5631-89C8-70C69DAE****",
  "DBInstances" : {
    "DBInstance" : [ {
      "ResourceGroupId" : "rg-acfmyiu4ekp****",
      "CapacityUnit" : "",
      "DBInstanceType" : "sharding",
      "StorageEngine" : "WiredTiger",
      "ReplicaSets" : {
        "ReplicaSet" : [ ]
      },
      "MaintainEndTime" : "22:00Z",
      "DBInstanceId" : "dds-bp11483712c1****",
      "MongosList" : {
        "MongosAttribute" : [ {
          "ConnectSting" : "s-bp18e6d84ae3****.mongodb.rds.aliyuncs.com",
          "Status" : "Running",
          "NodeClass" : "dds.mongos.mid",
          "NodeDescription" : "",
          "MaxConnections" : 1000,
          "VPCId" : "vpc-bp1n3i15v90el48nx****",
          "VSwitchId" : "vsw-bp1vj604nj5a9zz74****",
          "Port" : 3717,
          "NodeId" : "s-bp18e6d84ae3****",
          "VpcCloudInstanceId" : "s-bp18e6d84ae3****",
          "MaxIOPS" : 800
        }, {
          "ConnectSting" : "s-bp1a23593e64****.mongodb.rds.aliyuncs.com",
          "Status" : "Running",
          "NodeClass" : "dds.mongos.mid",
          "NodeDescription" : "",
          "MaxConnections" : 1000,
          "VPCId" : "vpc-bp1n3i15v90el48nx****",
          "VSwitchId" : "vsw-bp1vj604nj5a9zz74****",
          "Port" : 3717,
          "NodeId" : "s-bp1a23593e64****",
          "VpcCloudInstanceId" : "s-bp1a23593e64****",
          "MaxIOPS" : 800
        } ]
      },
      "NetworkType" : "VPC",
      "DBInstanceDescription" : "分片集群_dtstest1",
      "MaintainStartTime" : "18:00Z",
      "Engine" : "MongoDB",
      "Tags" : {
        "Tag" : [ ]
      },
      "DBInstanceReleaseProtection" : false,
      "EngineVersion" : "4.0",
      "DBInstanceStatus" : "Running",
      "ZoneId" : "cn-hangzhou-k",
      "MaxConnections" : 200,
      "VPCId" : "vpc-bp1n3i15v90el48nx****",
      "DBInstanceClass" : "dds.mongo.logic",
      "VSwitchId" : "vsw-bp1vj604nj5a9zz74****",
      "ShardList" : {
        "ShardAttribute" : [ {
          "Status" : "Running",
          "NodeClass" : "dds.shard.mid",
          "NodeDescription" : "",
          "MaxConnections" : 8000,
          "ReadonlyReplicas" : 0,
          "NodeId" : "d-bp14ec73d7bd****",
          "NodeStorage" : 10,
          "ConnectString" : "",
          "MaxIOPS" : 8000
        }, {
          "Status" : "Running",
          "NodeClass" : "dds.shard.mid",
          "NodeDescription" : "",
          "MaxConnections" : 8000,
          "ReadonlyReplicas" : 0,
          "NodeId" : "d-bp16e09d9c5d****",
          "NodeStorage" : 10,
          "ConnectString" : "",
          "MaxIOPS" : 8000
        } ]
      },
      "LockMode" : "Unlock",
      "MaxIOPS" : 800,
      "ChargeType" : "PostPaid",
      "VpcAuthMode" : "Close",
      "ProtocolType" : "mongodb",
      "CurrentKernelVersion" : "mongodb_20210625_3.0.35",
      "CreationTime" : "2021-07-20T11:20:01Z",
      "ConfigserverList" : {
        "ConfigserverAttribute" : [ {
          "Status" : "Running",
          "NodeClass" : "dds.cs.mid",
          "NodeDescription" : "",
          "NodeId" : "dds-bp11483712c1****-cs",
          "NodeStorage" : 20,
          "ConnectString" : ""
        } ]
      },
      "RegionId" : "cn-hangzhou",
      "KindCode" : 0
    } ]
  }
}

错误码

访问错误中心查看更多错误码。