DescribeDBInstances - ApsaraDB for MongoDB

Queries a list of ApsaraDB for MongoDB instances.

Operation description

The list of replica set and standalone instances is displayed when the DBInstanceType parameter uses the default value replicate. To query a list of sharded cluster instances, you must set the DBInstanceType parameter to sharding.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DescribeDBInstances	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/* Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The number of the page to return. The value of this parameter must be an integer that is greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 (default) 50 100	30
DBInstanceId	string	No	The instance ID.	dds-bp199659b178****
ReplicationFactor	string	No	The number of nodes in the replica set instance. Valid values: 3 5 7	3
DBInstanceDescription	string	No	The name of the instance. The name must meet the following requirements: The name must start with a letter. It can contain digits, letters, underscores (_), and hyphens (-). It must be 2 to 256 characters in length.	Test database
ExpireTime	string	No	The time when the instance expires.	2019-12-26T16:00Z
DBInstanceStatus	string	No	The state of the instance. For more information about valid values, see Instance states.	Running
DBInstanceType	string	No	The architecture of the instance. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance	sharding
DBInstanceClass	string	No	The instance type. For more information about valid values, see Instance types.	dds.mongo.mid
Engine	string	No	The database engine of the instance. Set the value to MongoDB.	MongoDB
EngineVersion	string	No	The database engine version of the instance. 6.0 5.0 4.4 4.2 4.0 3.4	4.0
NetworkType	string	No	The network type of the instance. Valid values: Classic VPC	VPC
VpcId	string	No	The VPC ID of the instance.	vpc-bp1n3i15v90el48nx****
VSwitchId	string	No	The vSwitch ID of the instance.	vsw-bp1vj604nj5a9zz74****
ChargeType	string	No	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	PrePaid
ZoneId	string	No	The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list.	cn-hangzhou-b
Expired	string	No	Specifies whether the instance has expired. Valid values: true false	true
ConnectionDomain	string	No	The endpoint of the node. You can call the DescribeDBInstanceAttribute operation to query the endpoint of the node.	dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmyiu4ekp****
Tag	array<object>	No	The tags of the instance.
	object	No
Key	string	No	The tag key of the instance. Valid values of N: 1 to 20. The key cannot start with `aliyun`, `acs:`, `http://`, or `https://`. It can be up to 64 characters in length. It cannot be an empty string.	testdatabase
Value	string	No	The tag value of the instance. Valid values of N: 1 to 20. The value cannot start with `aliyun`, `acs:`, `http://`, or `https://`. The value can be up to 128 characters in length. It can be an empty string.	apitest
DBNodeType	string	No	The type of the node in the instance. This parameter is used to filter standard or test instance. Valid value for a standalone or DBFS instance. Valid value for a standard instance that comes in the replica set or sharded cluster architecture: standard Valid value when all instances are displayed: default	default

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The number of instances in the query results.	5
RequestId	string	The request ID.	0E4FE33F-5510-5758-8FA7-A6672CDE****
PageSize	integer	The number of entries returned on each page.	30
PageNumber	integer	The page number of the returned page.	1
DBInstances	array<object>	The details of the instance.
	object
CreationTime	string	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.	2021-03-25T02:18:00Z
ChargeType	string	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	PrePaid
Tags	array<object>	The details of the tag.
	object	The details of the resource tags.
Key	string	The tag key.	test
Value	string	The tag value.	api
VpcAuthMode	string	Indicates whether password-free access over virtual private cloud (VPC) is enabled. Valid values: Open: Password-free access over VPC is enabled. Close: Password-free access over VPC is disabled.	Close
NetworkType	string	The network type of the instance. Valid values: Classic: classic network VPC: VPC	Classic
LockMode	string	The lock status of the instance. Valid values: Unlock: The cluster is unlocked. 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 after the storage space is exhausted. Released: The instance is released. After an instance is released, the instance cannot be unlocked. You can only restore the backup data of the instance to a new instance. This process requires a long period of time.	Unlock
EngineVersion	string	The database engine version of the instance. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
MongosList	array<object>	The details of the mongos node. Note This parameter is returned if the instance is a sharded cluster instance.
	object	The details of the mongos node. Note This parameter is returned if the instance is a sharded cluster instance.
NodeClass	string	The instance type of the mongos node.	dds.mongos.standard
NodeDescription	string	The description of the mongos node.	testmongosnode
NodeId	string	The ID of the mongos node.	s-bp10e3b0d02f****
DBInstanceDescription	string	The description of the instance.	Test database
ExpireTime	string	The time when the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.	2021-11-25T16:00Z
DBInstanceType	string	The architecture of the instance. sharding: sharded cluster instance replicate: replica set or standalone instance	sharding
LastDowngradeTime	string	The date when the last downgrade operation was performed.	2021-05-08
ShardList	array<object>	The details of the shard node. Note This parameter is returned if the instance is a sharded cluster instance.
	object	The details of the shard node. Note This parameter is returned if the instance is a sharded cluster instance.
NodeClass	string	The instance type of the shard node.	dds.shard.mid
NodeDescription	string	The description of the shard node.	testshardnode
NodeStorage	integer	The storage capacity of the shard node. Unit: GB.	10
NodeId	string	The ID of the shard node.	d-bp1cac6f2083****
ReadonlyReplicas	integer	The number of read-only nodes in the shard node. Valid values: 0 to 5.	2
DestroyTime	string	The time when the instance data is destroyed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note For a subscription instance, the computing resources of the instance are released on the 16th day after expiration, and the data of the instance is retained for seven days. The data is deleted on the 23th day after expiration and cannot be restored. For a pay-as-you-go instance, the computing resources of the instance are released on the 16th day after the payment becomes overdue, and the data of the instance is retained for seven days. The data is deleted on the 23th day after the payment becomes overdue and cannot be restored.	2021-12-10T16:00:00Z
DBInstanceStatus	string	The status of the instance. For more information, see Instance states.	Running
RegionId	string	The region ID of the instance.	cn-hangzhou
DBInstanceStorage	integer	The storage capacity of the instance.	20
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfmyiu4ekp****
ZoneId	string	The zone ID of the instance.	cn-hangzhou-g
DBInstanceId	string	The instance ID.	dds-bp18b0934e70****
DBInstanceClass	string	The instance type of the instance.	dds.mongo.mid
Engine	string	The engine of the instance.	MongoDB
ReplicationFactor	string	The number of nodes in the instance. Note This parameter is returned if the instance is a replica set instance.	3
KindCode	string	The kind code of the instance. Valid values: 0: physical machine 1: Elastic Compute Service (ECS) instance 2: Docker cluster 18: Kubernetes cluster	1
CapacityUnit	string	The I/O throughput consumed by the instance. Note This parameter is required only when the instance is a serverless instance.	100
StorageType	string	The storage type of the instance. Valid values: cloud_essd: Enterprise SSD (ESSD) local_ssd: local SSD	local_ssd
SecondaryZoneId	string	The secondary zone 1 of the instance in the multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G cn-hangzhou-h: Hangzhou Zone H cn-hangzhou-i: Hangzhou Zone I cn-hongkong-b: Hong Kong Zone B cn-hongkong-c: Hong Kong Zone C cn-hongkong-d: Hong Kong 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 only when the instance is a replica set or sharded cluster instance that runs MongoDB 4.4 or 5.0 and uses the multi-zone deployment. This parameter is returned only if you use the China site (aliyun.com).	cn-hangzhou-i
HiddenZoneId	string	The secondary zone 2 of the instance in the multi-zone deployment. Valid values: cn-hangzhou-g: Hangzhou Zone G cn-hangzhou-h: Hangzhou Zone H cn-hangzhou-i: Hangzhou Zone I cn-hongkong-b: Hong Kong Zone B cn-hongkong-c: Hong Kong Zone C cn-hongkong-d: Hong Kong 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 only when the instance is a replica set or sharded cluster instance that runs MongoDB 4.4 or 5.0 and uses the multi-zone deployment. This parameter is returned only if you use the China site (aliyun.com).	cn-hangzhou-h
BackupRetentionPolicy	integer	The backup retention policy configured for the instance. Valid values: 0: All backup sets of the instance are immediately deleted when the instance is released. 1: A backup set of the instance is automatically backed up and retained for a long period of time when the instance is released. 2: All backup sets of the instance are automatically backed up and retained for a long period of time when the instance is released.	1
ReleaseTime	string	The time when the instance was released.	2024-06-17T07:01Z

Examples

Sample success responses

JSONformat

{
  "TotalCount": 5,
  "RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2021-03-25T02:18:00Z",
        "ChargeType": "PrePaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Close",
        "NetworkType": "Classic",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "MongosList": {
          "MongosAttribute": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "testmongosnode\n",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "Test database\n",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "testshardnode\n",
              "NodeStorage": 10,
              "NodeId": "d-bp1cac6f2083****",
              "ReadonlyReplicas": 2
            }
          ]
        },
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 20,
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp18b0934e70****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReplicationFactor": "3",
        "KindCode": "1",
        "CapacityUnit": "100",
        "StorageType": "local_ssd",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "BackupRetentionPolicy": 1,
        "ReleaseTime": "2024-06-17T07:01Z"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-29	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-07-31	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-12-27	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-12-27	The response structure of the API has changed	View Change Details