DescribeDBInstancesOverview - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the overview information of one or more ApsaraDB for MongoDB instances.

Operation description

If you do not specify an instance when you call this operation, the overview information of all instances in a specific region within this account is returned.
Paged query is disabled for this operation.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
InstanceIds	string	No	The ID of the instance for which you want to query the overview information. Note If you do not specify this parameter, the overview information of all instances within this account is queried. Separate the instance IDs with commas (,).	dds-bp12c5b040dc****
InstanceStatus	string	No	The state of the instance. For more information about valid values, see Instance states.	Running
ChargeType	string	No	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	PostPaid
NetworkType	string	No	The network type of the instance. Valid values: Classic: classic network VPC: Virtual Private Cloud (VPC)	Classic
EngineVersion	string	No	The database engine version of the instance. Valid values: 5.0, 4.4, 4.2, 4.0, and 3.4.	4.0
InstanceClass	string	No	The instance type. The instance type varies based on the instance architecture. For more information about instance types supported by different instance architectures, see the following references: Standalone instance types Replica set instance types Sharded cluster instance types	dds.mongo.2xlarge
VpcId	string	No	The ID of the VPC in which the instance is deployed.	vpc-bp1nme44gek34slfc****
VSwitchId	string	No	The ID of the vSwitch to which the instance is connected.	vsw-bp1e7clcw529l773d****
InstanceType	string	No	The architecture of the instance. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance Note To query the overview information of a sharded cluster instance, you must set the parameter to sharding. If you do not specify this parameter, the overview information of all instances within this account is queried.	replicate
ZoneId	string	No	The zone ID of the instance.	cn-hangzhou-b
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. For more information, see View the basic information of a resource group.	rg-acfmyiu4ekp****

Response parameters

Parameter	Type	Description	Example
	object	The overview information of the instances.
TotalCount	string	The number of instances in the query results.	1
RequestId	string	The request ID.	52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
DBInstances	object []	The information of instances.
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.	2022-01-05T03:18:53Z
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.	2022-02-05T16:00Z
Tags	object []	The tags to add to the instance.
Key	string	The tag key. 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	The tag value. 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. The value can be an empty string.	apitest
LastDowngradeTime	string	The date when the last downgrade operation was performed.	2021-05-08
ShardList	object []	The details of the shard nodes. Note This parameter is returned when 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.	testshard
NodeStorage	integer	The storage space 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
DBInstanceType	string	The architecture of the instance. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance	replicate
DestroyTime	string	The time when the instance data was destroyed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-10T16:00:00Z
ChargeType	string	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go	PrePaid
CapacityUnit	string	The read and write throughput consumed by the instance. Note This parameter is returned when the instance is a serverless instance. Serverless instances are available only in the China site (aliyun.com).	100
VpcAuthMode	string	Indicates whether password-free access over VPC is enabled. Valid values: Open: Password-free access over VPC is enabled. Close: Password-free access over VPC is disabled.	Open
DBInstanceStatus	string	The state of the instance. For more information about valid values, see Instance states.	Running
NetworkType	string	The network type of the instance. Valid values: Classic VPC	VPC
LockMode	string	Indicates whether the instance is locked. 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 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.	4.2
MongosList	object []	The details of the mongos nodes. Note This parameter is returned when 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.	mongos node describe.
NodeId	string	The ID of the mongos node.	s-bp10e3b0d02f****
RegionId	string	The region ID of the instance.	cn-hangzhou
DBInstanceStorage	integer	The storage space of the instance. Unit: GB.	20
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfm22cdcgc****
ZoneId	string	The zone ID of the instance.	cn-hangzhou-i
DBInstanceId	string	The instance ID.	dds-bp12c5b040dc****
DBInstanceClass	string	The instance type. The instance type varies based on the instance architecture. For more information about instance types supported by different instance architectures, see the following references: Standalone instance types Replica set instance types Sharded cluster instance types	dds.mongo.mid
Engine	string	The database engine of the instance. Set the value to MongoDB.	MongoDB
ReplicationFactor	string	The number of nodes in the instance. Note This parameter is returned when the instance is a replica set instance.	3
DBInstanceDescription	string	The description of the instance.	test db
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	0

Examples

Sample success responses

JSONformat

{
  "TotalCount": "1",
  "RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances": [
    {
      "CreationTime": "2022-01-05T03:18:53Z",
      "ExpireTime": "2022-02-05T16:00Z",
      "Tags": [
        {
          "Key": "testdatabase",
          "Value": "apitest"
        }
      ],
      "LastDowngradeTime": "2021-05-08",
      "ShardList": [
        {
          "NodeClass": "dds.shard.mid",
          "NodeDescription": "testshard",
          "NodeStorage": 10,
          "NodeId": "d-bp1cac6f2083****",
          "ReadonlyReplicas": 2
        }
      ],
      "DBInstanceType": "replicate",
      "DestroyTime": "2021-12-10T16:00:00Z",
      "ChargeType": "PrePaid",
      "CapacityUnit": "100",
      "VpcAuthMode": "Open",
      "DBInstanceStatus": "Running",
      "NetworkType": "VPC",
      "LockMode": "Unlock",
      "EngineVersion": "4.2",
      "MongosList": [
        {
          "NodeClass": "dds.mongos.standard",
          "NodeDescription": "mongos node describe.",
          "NodeId": "s-bp10e3b0d02f****"
        }
      ],
      "RegionId": "cn-hangzhou",
      "DBInstanceStorage": 20,
      "ResourceGroupId": "rg-acfm22cdcgc****",
      "ZoneId": "cn-hangzhou-i",
      "DBInstanceId": "dds-bp12c5b040dc****",
      "DBInstanceClass": "dds.mongo.mid",
      "Engine": "MongoDB",
      "ReplicationFactor": "3",
      "DBInstanceDescription": "test db",
      "KindCode": "0"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-01-11	Add Operation	see changesets