You can call this operation to query 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.

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

Engine String No MongoDB

The database engine. Set the value to MongoDB.

RegionId String No cn-hangzhou

The ID of the region where the instance is deployed. You can call the DescribeRegions operation to query the region ID.

ResourceGroupId String No sg-bpxxxxxxxxxxxxxxxxxx

The ID of the resource group.

Response parameters

Parameter Type Example Description
RequestId String C373EED9-5125-4DD9-89DB-FB1ECD2C2B4F

The ID of the request.

DBInstances Array

A list of instance details.

DBInstance
ChargeType String PostPaid

The billing method of the instance.

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
ConfigserverList Array

The list of config servers.

Note This parameter is returned if the instance type is sharded cluster.
ConfigserverAttribute
ConnectString String mongodb://root:****@dds-bpxxxxxxxxxxxxxx-cs1730-pub.mongodb.rds.aliyuncs.com:3717,

The endpoint of the config server.

MaxConnections Integer 0

The maximum number of connections on the config server.

MaxIOPS Integer 1000

The maximum input/output operations per second (IOPS) of the config server.

NodeClass String dds.cs.mid

The instance type of the config server.

NodeDescription String testConfigserver

The name of the config server.

NodeId String dds-bpxxxxxxxxxxxxxx-cs

The ID of the config server.

NodeStorage Integer 20

The storage space of the config server.

Port Integer 3717

The port of the config server.

CreationTime String 2018-11-21T05:10:00Z

The time when the instance was created. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

CurrentKernelVersion String mongodb_20180914_1.1.5

The minor version number of the current database.

DBInstanceClass String dds.mongo.mid

The instance type.

DBInstanceDescription String Test

The name of the instance.

DBInstanceId String dds-bpxxxxxxxx

The ID of the instance.

DBInstanceReleaseProtection Boolean true

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

  • true: Release protection is enabled.
  • false: Release protection is disabled.
DBInstanceStatus String Running

The status of the instance. For more information, see Instance states.

DBInstanceStorage Integer 10

The storage space of the instance.

DBInstanceType String replicate

The instance type.

  • replicate: a replica set instance
  • sharding: a sharded cluster instance
Engine String MongoDB

The database engine.

EngineVersion String 3.4

The database version.

ExpireTime String 2019-04-08T16:00Z

The time when the subscription instance expires. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Note This parameter is returned if the instance billing method is subscription.
KindCode String 1

The type of the instance. Valid values:

  • 0: a physical machine
  • 1: an Elastic Compute Service (ECS) instance
  • 2: a Docker cluster instance
  • 18: a Kubernetes cluster instance
LastDowngradeTime String 2019-03-08

The time when the instance was last downgraded.

LockMode String Unlock

Indicates whether the instance is locked.

  • Unlock: The instance is not locked.
  • ManualLock: The instance has been manually locked.
  • LockByExpiration: The instance has been locked upon expiration.
  • LockByRestoration: The instance has been locked for a rollback.
  • LockByDiskQuota: The instance has been automatically locked because its storage space is exhausted.
  • Released: The instance has been released. You cannot unlock a released instance. After an instance is released, you can only use a backup to restore the data of the instance to a new instance. This process requires a long time.
MaintainEndTime String 03:00Z

The end time of the maintenance window. Specify the time in the HH:mmZ format. The time must be in UTC.

MaintainStartTime String 02:00Z

The start time of the maintenance window. Specify the time in the HH:mmZ format. The time must be in UTC.

MaxConnections Integer 500

The maximum number of connections on the instance.

MaxIOPS Integer 1000

The maximum IOPS of the instance.

MongosList Array

The list of mongos.

Note This parameter is returned if the instance type is sharded cluster.
MongosAttribute
ConnectSting String s-bpxxxxxxxx.mongodb.rds.aliyuncs.com

The endpoint of the mongos.

MaxConnections Integer 1000

The maximum number of connections on the mongos.

MaxIOPS Integer 0

The maximum IOPS of the mongos.

NodeClass String dds.mongos.mid

The instance type of the mongos.

NodeDescription String mongos1

The name of the mongos.

NodeId String s-bpxxxxxxxx

The ID of the mongos.

Port Integer 3717

The port of the mongos.

VPCId String vpc-bp1xxxxxxxxxxxxxxxxxx

The ID of the virtual private cloud (VPC) to which the mongos belongs.

VSwitchId String vsw-bp1xxxxxxxxxxxxxxxxxx

The ID of the VSwitch that is connected to the mongos.

VpcCloudInstanceId String s-bp1xxxxxxxxxxxxx

The mongos ID assigned by the virtual private cloud (VPC).

NetworkType String VPC

The network type of the instance.

  • Classic
  • VPC
ProtocolType String mongodb

The access protocol type of the instance. Valid values:

  • mongodb: the MongoDB protocol
  • dynamodb: the DynamoDB protocol
ReadonlyReplicas String 0

The number of read-only nodes in the instance.

RegionId String cn-hangzhou

The ID of the region where the instance is deployed.

ReplacateId String bls-mxxxxxxxx

The ID of the BLS channel.

ReplicaSetName String mgset-10xxxxxxxx

The name of the instance replica set.

Note This parameter is returned if the instance type is replica set.
ReplicaSets Array

The information of the replica set.

Note This parameter is returned if the instance type is replica set.
ReplicaSet
ConnectionDomain String dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com

The endpoint of the node.

ConnectionPort String ConnectionPort

The port of the node.

NetworkType String VPC

The network type of the node.

  • Classic
  • VPC
ReplicaSetRole String Primary

The role of the node.

  • Primary
  • Secondary
VPCCloudInstanceId String vpc-xxxxxxxx

The ID of the VPC.

VPCId String vpc-bpxxxxxxxx

The node ID assigned by the VPC.

VSwitchId String vsw-bpxxxxxxxx

The ID of the VSwitch in the VPC to which the node belongs.

ReplicationFactor String 3

The number of nodes in the instance.

Note This parameter is returned if the instance type is replica set.
ResourceGroupId String rg-axxxxxxxx

The ID of the resource group to which the instance belongs.

ShardList Array

The list of shards.

Note This parameter is returned if the instance type is sharded cluster.
ShardAttribute
ConnectString String d-bpxxxxxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com

The endpoint of the shard.

MaxConnections Integer 8000

The maximum number of connections on the shard.

MaxIOPS Integer 8000

The maximum IOPS of the shard.

NodeClass String dds.shard.mid

The instance type of the shard.

NodeDescription String testshard

The name of the shard.

NodeId String d-bpxxxxxxxx

The ID of the shard.

NodeStorage Integer 10

The storage space of the shard.

Port Integer 3717

The port of the shard.

StorageEngine String WiredTiger

The storage engine of the instance.

Tags Array

The list of instance tags.

Tag
Key String test

The key of the instance tag.

Value String api

The value of the instance tag.

VPCCloudInstanceIds String s-bp1xxxxxxxxxxxxx

The instance ID assigned by the VPC.

VPCId String vpc-bpxxxxxxxx

The ID of the VPC.

VSwitchId String vsw-bpxxxxxxxx

The ID of the VSwitch that is connected to the VPC.

VpcAuthMode String Open

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

  • Open: Password-free access is enabled.
  • Close: Password-free access is disabled.
  • NotSupport: Authentication is not supported.
ZoneId String cn-hangzhou-b

The ID of the zone to which the instance belongs.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDBInstanceAttributeResponse>
      <RequestId>9E7B90E1-AD90-4DD9-B1FB-E3BE2E0FDD48</RequestId>
      <DBInstances>
            <DBInstance>
                  <CurrentKernelVersion>mongodb_20190408_3.0.12</CurrentKernelVersion>
                  <ZoneId>cn-hangzhou-b</ZoneId>
                  <MongosList></MongosList>
                  <VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
                  <Engine>MongoDB</Engine>
                  <ReplicationFactor>3</ReplicationFactor>
                  <NetworkType>VPC</NetworkType>
                  <VPCId>vpc-bpxxxxxxxx</VPCId>
                  <MaintainStartTime>18:00Z</MaintainStartTime>
                  <MaxConnections>500</MaxConnections>
                  <ReplicaSets>
                        <ReplicaSet>
                              <NetworkType>VPC</NetworkType>
                              <VPCId>vpc-bpxxxxxxxx</VPCId>
                              <ConnectionPort>3717</ConnectionPort>
                              <ReplicaSetRole>Primary</ReplicaSetRole>
                              <ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
                              <VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
                              <VPCCloudInstanceId>dds-bpxxxxxxxx</VPCCloudInstanceId>
                        </ReplicaSet>
                        <ReplicaSet>
                              <NetworkType>VPC</NetworkType>
                              <VPCId>vpc-bpxxxxxxxx</VPCId>
                              <ConnectionPort>3717</ConnectionPort>
                              <ReplicaSetRole>Secondary</ReplicaSetRole>
                              <ConnectionDomain>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</ConnectionDomain>
                              <VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
                              <VPCCloudInstanceId>dds-bpxxxxxxxx</VPCCloudInstanceId>
                        </ReplicaSet>
                  </ReplicaSets>
                  <DBInstanceType>replicate</DBInstanceType>
                  <VpcAuthMode>Open</VpcAuthMode>
                  <EngineVersion>4.0</EngineVersion>
                  <DBInstanceStatus>Running</DBInstanceStatus>
                  <ChargeType>PostPaid</ChargeType>
                  <LockMode>Unlock</LockMode>
                  <MaxIOPS>1000</MaxIOPS>
                  <MaintainEndTime>22:00Z</MaintainEndTime>
                  <DBInstanceClass>dds.mongo.mid</DBInstanceClass>
                  <DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
                  <ResourceGroupId>rg-xxxxxxxx</ResourceGroupId>
                  <DBInstanceDescription>Test database</DBInstanceDescription>
                  <DBInstanceStorage>10</DBInstanceStorage>
                  <CreationTime>2019-04-23T03:52:01Z</CreationTime>
                  <Tags></Tags>
                  <RegionId>cn-hangzhou</RegionId>
                  <StorageEngine>WiredTiger</StorageEngine>
                  <ShardList></ShardList>
                  <ReplicaSetName>mgset-xxxxxxxx</ReplicaSetName>
            </DBInstance>
      </DBInstances>
</DescribeDBInstanceAttributeResponse>

JSON format

{
    "RequestId": "9E7B90E1-AD90-4DD9-B1FB-E3BE2E0FDD48",
    "DBInstances": {
        "DBInstance": [
            {
                "CurrentKernelVersion": "mongodb_20190408_3.0.12",
                "ZoneId": "cn-hangzhou-b",
                "MongosList": {
                    "MongosAttribute": []
                },
                "VSwitchId": "vsw-bpxxxxxxxx",
                "Engine": "MongoDB",
                "ReplicationFactor": "3",
                "NetworkType": "VPC",
                "VPCId": "vpc-bpxxxxxxxx",
                "MaintainStartTime": "18:00Z",
                "MaxConnections": 500,
                "ReplicaSets": {
                    "ReplicaSet": [
                        {
                            "NetworkType": "VPC",
                            "VPCId": "vpc-bpxxxxxxxx",
                            "ConnectionPort": "3717",
                            "ReplicaSetRole": "Primary",
                            "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
                            "VSwitchId": "vsw-bpxxxxxxxx",
                            "VPCCloudInstanceId": "dds-bpxxxxxxxx"
                        },
                        {
                            "NetworkType": "VPC",
                            "VPCId": "vpc-bpxxxxxxxx",
                            "ConnectionPort": "3717",
                            "ReplicaSetRole": "Secondary",
                            "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
                            "VSwitchId": "vsw-bpxxxxxxxx",
                            "VPCCloudInstanceId": "dds-bpxxxxxxxx"
                        }
                    ]
                },
                "DBInstanceType": "replicate",
                "VpcAuthMode": "Open",
                "EngineVersion": "4.0",
                "DBInstanceStatus": "Running",
                "ChargeType": "PostPaid",
                "LockMode": "Unlock",
                "MaxIOPS": 1000,
                "MaintainEndTime": "22:00Z",
                "DBInstanceClass": "dds.mongo.mid",
                "DBInstanceId": "dds-bpxxxxxxxx",
                "ResourceGroupId": "rg-xxxxxxxx",
                "DBInstanceDescription": "Test database",
                "DBInstanceStorage": 10,
                "CreationTime": "2019-04-23T03:52:01Z",
                "Tags": {
                    "Tag": []
                },
                "RegionId": "cn-hangzhou",
                "StorageEngine": "WiredTiger",
                "ShardList": {
                    "ShardAttribute": []
                },
                "ReplicaSetName": "mgset-xxxxxxxx"
            }
        ]
    }
}

Error codes

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