DescribeDBInstanceAttribute -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBInstanceAttribute	The operation that you want to perform. Set the value to DescribeDBInstanceAttribute.
RegionId	String	No	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
Engine	String	No	MongoDB	The database engine of the instance. The value is set to MongoDB.
DBInstanceId	String	Yes	dds-bp11483712c1****	The ID of the instance.
ResourceGroupId	String	No	rg-acfmyiu4ekp****	The ID of the resource group. For more information, see View basic information of a resource group. Note This parameter is available only if you use the China site (aliyun.com).

Response parameters


Parameter	Type	Example	Description
RequestId	String	A935A8EE-A6CC-53DE-98BA-20ABAA7E632B	The ID of the request.
DBInstances	Array of DBInstance		Details of the instance.
DBInstance
CreationTime	String	2022-01-02T07:43:59Z	The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
ReplicaSets	Array of ReplicaSet		Details of the replica set instance. Note This parameter is returned if the instance is a replica set instance.
ReplicaSet
VSwitchId	String	vpc-bp1jk5vwkcri27qme****	The ID of the vSwitch. Note This parameter is returned if the network type of the instance is Virtual Private Cloud (VPC).
ConnectionPort	String	3717	The port number that is used to connect to the node.
ReplicaSetRole	String	Primary	The role of the node. Valid values: Primary Secondary
ConnectionDomain	String	dds-bp11483712c1****.mongodb.rds.aliyuncs.com	The endpoint of the node.
VPCCloudInstanceId	String	dds-bp11483712c1****	The ID of the instance. Note This parameter is returned if the network type of the instance is VPC.
NetworkType	String	VPC	The network type of the instance. Valid values: Classic: classic network VPC: VPC
VPCId	String	vpc-bp1jk5vwkcri27qme****	The ID of the VPC. Note This parameter is returned if the network type of the instance is VPC.
ReplacateId	String	bls-m****	The logical ID of the replica instance. Note ApsaraDB for MongoDB does not support new instances of this type. This parameter applies only to previous-version replica instances.
ChargeType	String	PostPaid	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go
Tags	Array of Tag		Details of the instance tags.
Tag
Key	String	test	The tag key of the instance.
Value	String	api	The tag value of the instance.
VpcAuthMode	String	Open	Indicates whether password-free access within the VPC is enabled. Valid values: Open: Password-free access is enabled. Close: Password-free access is disabled, and you must use a password for access. NotSupport: Password-free access is not supported.
NetworkType	String	VPC	The network type of the instance. Valid values: Classic: classic network VPC: VPC
LockMode	String	Unlock	The lock state of the instance. Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked before it is rolled back. LockByDiskQuota: The instance is automatically locked due to exhausted storage capacity. Released: The instance is released.
EngineVersion	String	4.4	The database engine version of the instance. Valid values: 5.0 4.4 4.2 4.0 3.4
MaxIOPS	Integer	1000	The maximum IOPS of the instance.
VPCCloudInstanceIds	String	dds-bp11483712c1****	The ID of the instance. Note This parameter is returned if the network type of the instance is VPC.
MongosList	Array of MongosAttribute		Details of the mongos nodes. Note This parameter is returned if the instance is a sharded cluster instance.
MongosAttribute
VpcCloudInstanceId	String	s-bp1d8c262a158****	The ID of the mongos node.
MaxIOPS	Integer	800	The maximum IOPS of the mongos node.
VSwitchId	String	vsw-bp1vj604nj5a9zz74****	The ID of the vSwitch. Note This parameter is returned if the network type of the instance is VPC.
NodeClass	String	dds.mongos.mid	The type of the mongos node.
MaxConnections	Integer	1000	The maximum number of connections to the mongos node.
Port	Integer	3717	The port number that is used to connect to the mongos node.
VPCId	String	vpc-bp1n3i15v90el48nx****	The ID of the VPC. Note This parameter is returned if the network type of the instance is VPC.
ConnectSting	String	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com	The endpoint of the mongos node.
NodeDescription	String	mongos1	The name of the mongos node.
NodeId	String	s-bp1d8c262a15****	The ID of the mongos node.
Status	String	Running	The state of the mongos node. For more information, see Instance states.
ProtocolType	String	mongodb	The access protocol type of the instance. Valid values: mongodb: the MongoDB protocol dynamodb: the DynamoDB protocol Note This parameter is returned if the instance is a sharded cluster instance.
DBInstanceDescription	String	testdatabase	The name of the instance.
CurrentKernelVersion	String	mongodb_20211014_3.0.38	The minor version of the current database in the instance.
DBInstanceReleaseProtection	Boolean	false	Indicates whether release protection is enabled for the instance. Valid values: true: Release protection is enabled. false: Release protection is disabled.
ExpireTime	String	2022-02-05T16:00Z	The time when the subscription instance expires. The time is in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. Note This parameter is returned if the instance is a subscription instance.
MaintainStartTime	String	18:00Z	The start time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.
DBInstanceType	String	replicate	The architecture of the instance. Valid values: replicate: replica set instance sharding: sharded cluster instance
LastDowngradeTime	String	2022-01-08	The date when the last downgrade operation was performed.
ShardList	Array of ShardAttribute		Details of the shard nodes. Note This parameter is returned if the instance is a sharded cluster instance.
ShardAttribute
MaxIOPS	Integer	8000	The maximum IOPS of the shard node.
ConnectString	String	d-bp1af0680a9c6d3**.mongodb.rds.aliyuncs.com:**	The endpoint of the shard node.
NodeClass	String	dds.shard.mid	The type of the shard node.
MaxConnections	Integer	8000	The maximum number of connections to the shard node.
Port	Integer	3717	The port number that is used to connect to the shard node.
NodeDescription	String	testshard	The name of the shard node.
NodeId	String	d-bp16e09d9c5d****	The ID of the shard node.
NodeStorage	Integer	10	The storage capacity of the shard node.
ReadonlyReplicas	Integer	0	The number of read-only nodes in the shard node. Valid values: 0 to 5. The value must be an integer.
Status	String	Running	The state of the shard node. For more information, see Instance states.
MaintainEndTime	String	03:00Z	The end time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.
DBInstanceStatus	String	Running	The state of the instance. For more information, see Instance states.
VPCId	String	vpc-bp1n3i15v90el48nx****	The ID of the VPC. Note This parameter is returned if the network type of the instance is VPC.
RegionId	String	cn-hangzhou	The region ID of the instance.
DBInstanceStorage	Integer	10	The storage capacity of the instance.
ReplicaSetName	String	mgset-10ace****	The name of the replica set instance. Note This parameter is returned if the instance is a replica set instance.
VSwitchId	String	vsw-bp1oo2a7isyrb8igf****	The ID of the vSwitch. Note This parameter is returned if the network type of the instance is VPC.
StorageEngine	String	WiredTiger	The storage engine of the instance.
ConfigserverList	Array of ConfigserverAttribute		Details of the Configserver nodes. Note This parameter is returned if the instance is a sharded cluster instance.
ConfigserverAttribute
MaxIOPS	Integer	1000	The maximum IOPS of the Configserver node.
ConnectString	String	dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com	The endpoint of the Configserver node.
NodeClass	String	dds.cs.mid	The type of the Configserver node.
MaxConnections	Integer	1000	The maximum number of connections to the Configserver node.
Port	Integer	3717	The port number that is used to connect to the Configserver node.
NodeDescription	String	testConfigserver	The name of the Configserver node.
NodeId	String	dds-bp11483712c1****-cs	The ID of the Configserver node.
NodeStorage	Integer	20	The storage capacity of the Configserver node.
Status	String	Running	The state of the Configserver node. For more information, see Instance states.
ResourceGroupId	String	rg-acfmyiu4ekp****	The ID of the resource group. Note This parameter is returned only if you use the Chine site (aliyun.com).
ZoneId	String	cn-hangzhou-b	The zone ID of the instance.
MaxConnections	Integer	500	The maximum number of connections to the instance.
DBInstanceId	String	dds-bp11483712c1****	The ID of the instance.
DBInstanceClass	String	dds.mongo.mid	The instance type.
Engine	String	MongoDB	The database engine of the instance.
ReadonlyReplicas	String	1	The number of read-only nodes in the instance.
ReplicationFactor	String	3	The number of nodes in the instance. Note This parameter is returned if the instance is a replica set instance.
KindCode	String	1	The kind code of the instance. Valid values: 0: physical machine 1: Elastic Compute Service (ECS) instance 2: Docker cluster 18: Kubernetes cluster
CapacityUnit	String	100	The I/O throughput consumed by the instance.
SecondaryZoneId	String	cn-hangzhou-i	The ID of the secondary zone 1 of the instance. Valid values: cn-hangzhou-g: Hangzhou Zone G cn-hangzhou-h: Hangzhou Zone H cn-hangzhou-i: Hangzhou Zone I cn-hongkong-b: Hongkong Zone B cn-hongkong-c: Hongkong Zone C cn-hongkong-d: Hongkong Zone D cn-wulanchabu-a: Ulanqab Zone A cn-wulanchabu-b: Ulanqab Zone B cn-wulanchabu-c: Ulanqab Zone C ap-southeast-1a: Singapore Zone A ap-southeast-1b: Singapore Zone B ap-southeast-1c: Singapore Zone C ap-southeast-5a: Jakarta Zone A ap-southeast-5b: Jakarta Zone B ap-southeast-5c: Jakarta Zone C eu-central-1a: Frankfurt Zone A eu-central-1b: Frankfurt Zone B eu-central-1c: Frankfurt Zone C Note This parameter is returned if the instance is a replica set or sharded cluster instance that runs MongoDB 4.4 or 5.0 and uses multi-zone deployment. This parameter is returned only if you use the Chine site (aliyun.com).
HiddenZoneId	String	cn-hangzhou-h	The ID of the secondary zone 2 of the instance. Valid values: cn-hangzhou-g: Hangzhou Zone G cn-hangzhou-h: Hangzhou Zone H cn-hangzhou-i: Hangzhou Zone I cn-hongkong-b: Hongkong Zone B cn-hongkong-c: Hongkong Zone C cn-hongkong-d: Hongkong Zone D cn-wulanchabu-a: Ulanqab Zone A cn-wulanchabu-b: Ulanqab Zone B cn-wulanchabu-c: Ulanqab Zone C ap-southeast-1a: Singapore Zone A ap-southeast-1b: Singapore Zone B ap-southeast-1c: Singapore Zone C ap-southeast-5a: Jakarta Zone A ap-southeast-5b: Jakarta Zone B ap-southeast-5c: Jakarta Zone C eu-central-1a: Frankfurt Zone A eu-central-1b: Frankfurt Zone B eu-central-1c: Frankfurt Zone C Note This parameter is returned if the instance is a replica set or sharded cluster instance that runs MongoDB 4.4 or 5.0 and uses multi-zone deployment. This parameter is returned only if you use the Chine site (aliyun.com).

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=dds-bp11483712c1****
&<Common request parameters>

Sample success responses

XML format

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>
        <ChargeType>PostPaid</ChargeType>
        <Tags>
            <Key>test</Key>
            <Value>api</Value>
        </Tags>
        <VpcAuthMode>Open</VpcAuthMode>
        <NetworkType>VPC</NetworkType>
        <LockMode>Unlock</LockMode>
        <EngineVersion>4.4</EngineVersion>
        <MaxIOPS>1000</MaxIOPS>
        <ProtocolType>mongodb</ProtocolType>
        <DBInstanceDescription>testdatabase</DBInstanceDescription>
        <CurrentKernelVersion>mongodb_20211014_3.0.38</CurrentKernelVersion>
        <DBInstanceReleaseProtection>false</DBInstanceReleaseProtection>
        <MaintainStartTime>18:00Z</MaintainStartTime>
        <DBInstanceType>replicate</DBInstanceType>
        <LastDowngradeTime>2022-01-08</LastDowngradeTime>
        <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>
        <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>
    </DBInstances>
</DescribeDBInstanceAttributeResponse>

JSON format

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****"
    },
    "ChargeType" : "PostPaid",
    "Tags" : {
      "Key" : "test",
      "Value" : "api"
    },
    "VpcAuthMode" : "Open",
    "NetworkType" : "VPC",
    "LockMode" : "Unlock",
    "EngineVersion" : 4.4,
    "MaxIOPS" : 1000,
    "ProtocolType" : "mongodb",
    "DBInstanceDescription": "testdatabase",
    "CurrentKernelVersion" : "mongodb_20211014_3.0.38",
    "DBInstanceReleaseProtection" : false,
    "MaintainStartTime" : "18:00Z",
    "DBInstanceType" : "replicate",
    "LastDowngradeTime" : "2022-01-08",
    "MaintainEndTime" : "03:00Z",
    "DBInstanceStatus" : "Running",
    "VPCId" : "vpc-bp1n3i15v90el48nx****",
    "RegionId" : "cn-hangzhou",
    "DBInstanceStorage" : 10,
    "ReplicaSetName" : "mgset-10ace****",
    "VSwitchId" : "vsw-bp1oo2a7isyrb8igf****",
    "StorageEngine" : "WiredTiger",
    "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
  }
}

Error codes

For a list of error codes, visit the API Error Center.