Queries the details of an ApsaraDB for MongoDB instance.

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. Set the value to MongoDB.

DBInstanceId String Yes dds-bp1a7009eb24****

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.

Response parameters

Parameter Type Example Description
RequestId String 4D22A5D2-32CF-57D4-9357-2DD68ECDCC59

The ID of the request.

DBInstances Array of DBInstance

Details about the instance.

DBInstance
CreationTime String 2021-12-09T09:06:01Z

The time when the instance was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

ReplicaSets Array of ReplicaSet

Details about the replica set instances.

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 is 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-bp12c5b040dc5****.mongodb.rds.aliyuncs.com

The endpoint of the node.

VPCCloudInstanceId String dds-bp12c5b040dc5d****

The ID of the instance.

Note This parameter is returned if the network type is VPC.
NetworkType String VPC

The network type of the instance. Valid values:

  • Classic
  • VPC
VPCId String vpc-bp1jk5vwkcri27qme****

The ID of the VPC.

Note This parameter is returned if the network type 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 old-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 about the instance tags.

Tag
Key String test

The key of tag N.

Value String api

The value of tag N.

VpcAuthMode String Open

Indicates whether password-free access within the VPC is enabled. Valid values: Valid values:

  • Open: Password-free access is enabled.
  • Close: Password-free access is disabled.
  • NotSupport: Password-free access is not supported.
NetworkType String VPC

The network type of the instance. Valid values:

  • Classic
  • VPC
LockMode String Unlock

Indicates whether the instance is locked. Valid values: Valid values:

  • Unlock: The instance is not locked.
  • ManualLock: The instance is manually locked.
  • LockByExpiration: The instance is automatically locked after it expires.
  • LockByRestoration: The instance is automatically locked before it is rolled back.
  • LockByDiskQuota: The instance is automatically locked after the storage space is exhausted.
  • Released: The instance is released.
EngineVersion String 4.2

The database engine version of the instance.

MaxIOPS Integer 1000

The maximum IOPS of the instance.

VPCCloudInstanceIds String dds-bp1a7009eb24****

The ID of the instance.

Note This parameter is returned if the network type is VPC.
MongosList Array of MongosAttribute

Details about 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.

Note This parameter is returned if the network type is VPC.
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 is VPC.
NodeClass String dds.mongos.mid

The instance 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 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 status 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
DBInstanceDescription String testdatabase

The name of the instance.

CurrentKernelVersion String mongodb_20211014_3.0.38

The minor version of the current database of the instance.

DBInstanceReleaseProtection Boolean false

Indicates whether release protection is enabled for the instance. Valid values:

  • true
  • false
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 instances. Valid values:

  • replicate: replica set instance
  • sharding: sharded cluster instance
LastDowngradeTime String 2022-01-08

The last time when the instance was downgraded.

ShardList Array of ShardAttribute

Details about 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 instance 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.

Status String Running

The status 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 status 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 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 is VPC.
StorageEngine String WiredTiger

The storage engine of the instance.

ConfigserverList Array of ConfigserverAttribute

Details about 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 instance 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 status of the Configserver node. For more information, see Instance states.

ResourceGroupId String rg-acfmyiu4ekp****

The ID of the resource group.

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 of the instance.

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 that you want to create 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: ECS instance
  • 2: Docker cluster
  • 18: Kubernetes cluster
CapacityUnit String 100

The I/O throughput consumed by the instance.

Note
  • This parameter is returned when the instance is a serverless instance.
  • Serverless instances are available only in China site (aliyun.com).

Examples

Sample requests

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

Sample success responses

XML format

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

<DescribeDBInstanceAttributeResponse>
    <RequestId>4D22A5D2-32CF-57D4-9357-2DD68ECDCC59</RequestId>
    <DBInstances>
        <DBInstance>
            <ResourceGroupId>rg-acfm22cdcgc****</ResourceGroupId>
            <CapacityUnit/>
            <DBInstanceType>sharding</DBInstanceType>
            <StorageEngine>WiredTiger</StorageEngine>
            <ReplicaSets>
            </ReplicaSets>
            <MaintainEndTime>22:00Z</MaintainEndTime>
            <DBInstanceId>dds-bp1a7009eb24****</DBInstanceId>
            <MongosList>
                <MongosAttribute>
                    <ConnectSting>s-bp1d8c262a15****.mongodb.rds.aliyuncs.com</ConnectSting>
                    <Status>Running</Status>
                    <NodeClass>dds.mongos.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>1000</MaxConnections>
                    <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
                    <Port>3717</Port>
                    <NodeId>s-bp1d8c262a15****</NodeId>
                    <VpcCloudInstanceId>s-bp1d8c262a15****</VpcCloudInstanceId>
                    <MaxIOPS>800</MaxIOPS>
                </MongosAttribute>
                <MongosAttribute>
                    <ConnectSting>s-bp1428aecdea****.mongodb.rds.aliyuncs.com</ConnectSting>
                    <Status>Running</Status>
                    <NodeClass>dds.mongos.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>1000</MaxConnections>
                    <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
                    <Port>3717</Port>
                    <NodeId>s-bp1428aecdea1674</NodeId>
                    <VpcCloudInstanceId>s-bp1428aecdea****</VpcCloudInstanceId>
                    <MaxIOPS>800</MaxIOPS>
                </MongosAttribute>
            </MongosList>
            <NetworkType>VPC</NetworkType>
            <MaintainStartTime>18:00Z</MaintainStartTime>
            <Engine>MongoDB</Engine>
            <Tags>
            </Tags>
            <DBInstanceReleaseProtection>false</DBInstanceReleaseProtection>
            <EngineVersion>4.0</EngineVersion>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <MaxConnections>200</MaxConnections>
            <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
            <DBInstanceClass>dds.mongo.logic</DBInstanceClass>
            <VSwitchId>vsw-bp1p9le7ibusmjf94****</VSwitchId>
            <ShardList>
                <ShardAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.shard.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>8000</MaxConnections>
                    <ReadonlyReplicas>0</ReadonlyReplicas>
                    <NodeId>d-bp128a003436****</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-bp1ecfe9926b****</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_20211014_3.0.38</CurrentKernelVersion>
            <CreationTime>2021-12-09T09:06:01Z</CreationTime>
            <ConfigserverList>
                <ConfigserverAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.cs.mid</NodeClass>
                    <NodeDescription/>
                    <NodeId>dds-bp1a7009eb24fec****</NodeId>
                    <NodeStorage>20</NodeStorage>
                    <ConnectString/>
                </ConfigserverAttribute>
            </ConfigserverList>
            <RegionId>cn-hangzhou</RegionId>
            <KindCode>0</KindCode>
        </DBInstance>
    </DBInstances>
</DescribeDBInstanceAttributeResponse>

JSON format

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

{
  "RequestId" : "4D22A5D2-32CF-57D4-9357-2DD68ECDCC59",
  "DBInstances" : {
    "DBInstance" : [ {
      "ResourceGroupId" : "rg-acfm22cdcgc****",
      "CapacityUnit" : "",
      "DBInstanceType" : "sharding",
      "StorageEngine" : "WiredTiger",
      "ReplicaSets" : {
        "ReplicaSet" : [ ]
      },
      "MaintainEndTime" : "22:00Z",
      "DBInstanceId" : "dds-bp1a7009eb24****",
      "MongosList" : {
        "MongosAttribute" : [ {
          "ConnectSting" : "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
          "Status" : "Running",
          "NodeClass" : "dds.mongos.mid",
          "NodeDescription" : "",
          "MaxConnections" : 1000,
          "VPCId" : "vpc-bp1jk5vwkcri27qme****",
          "Port" : 3717,
          "NodeId" : "s-bp1d8c262a15****",
          "VpcCloudInstanceId" : "s-bp1d8c262a15****",
          "MaxIOPS" : 800
        }, {
          "ConnectSting" : "s-bp1428aecdea****.mongodb.rds.aliyuncs.com",
          "Status" : "Running",
          "NodeClass" : "dds.mongos.mid",
          "NodeDescription" : "",
          "MaxConnections" : 1000,
          "VPCId" : "vpc-bp1jk5vwkcri27qme****",
          "Port" : 3717,
          "NodeId" : "s-bp1428aecdea1674",
          "VpcCloudInstanceId" : "s-bp1428aecdea****",
          "MaxIOPS" : 800
        } ]
      },
      "NetworkType" : "VPC",
      "MaintainStartTime" : "18:00Z",
      "Engine" : "MongoDB",
      "Tags" : {
        "Tag" : [ ]
      },
      "DBInstanceReleaseProtection" : false,
      "EngineVersion" : "4.0",
      "DBInstanceStatus" : "Running",
      "ZoneId" : "cn-hangzhou-h",
      "MaxConnections" : 200,
      "VPCId" : "vpc-bp1jk5vwkcri27qme****",
      "DBInstanceClass" : "dds.mongo.logic",
      "VSwitchId" : "vsw-bp1p9le7ibusmjf94****",
      "ShardList" : {
        "ShardAttribute" : [ {
          "Status" : "Running",
          "NodeClass" : "dds.shard.mid",
          "NodeDescription" : "",
          "MaxConnections" : 8000,
          "ReadonlyReplicas" : 0,
          "NodeId" : "d-bp128a003436****",
          "NodeStorage" : 10,
          "ConnectString" : "",
          "MaxIOPS" : 8000
        }, {
          "Status" : "Running",
          "NodeClass" : "dds.shard.mid",
          "NodeDescription" : "",
          "MaxConnections" : 8000,
          "ReadonlyReplicas" : 0,
          "NodeId" : "d-bp1ecfe9926b****",
          "NodeStorage" : 10,
          "ConnectString" : "",
          "MaxIOPS" : 8000
        } ]
      },
      "LockMode" : "Unlock",
      "MaxIOPS" : 800,
      "ChargeType" : "PostPaid",
      "VpcAuthMode" : "Close",
      "ProtocolType" : "mongodb",
      "CurrentKernelVersion" : "mongodb_20211014_3.0.38",
      "CreationTime" : "2021-12-09T09:06:01Z",
      "ConfigserverList" : {
        "ConfigserverAttribute" : [ {
          "Status" : "Running",
          "NodeClass" : "dds.cs.mid",
          "NodeDescription" : "",
          "NodeId" : "dds-bp1a7009eb24fec****",
          "NodeStorage" : 20,
          "ConnectString" : ""
        } ]
      },
      "RegionId" : "cn-hangzhou",
      "KindCode" : 0
    } ]
  }
}

Error codes

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