DescribeDBInstancesOverview - - Alibaba Cloud ドキュメントセンター

If you do not specify an instance when you call this operation, the overview information of all instances in the specified 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBInstancesOverview	The operation that you want to perform. Set the value to DescribeDBInstancesOverview.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.
InstanceIds	String	No	dds-bp12c5b040dc****	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 under this account is queried. Separate the instance IDs with commas (,).
InstanceStatus	String	No	Running	The state of the instance. For more information about valid values, see Instance states.
ChargeType	String	No	PostPaid	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go
NetworkType	String	No	Classic	The network type of the instance. Valid values: Classic VPC
EngineVersion	String	No	4.0	The database engine version of the instance. Valid values: 5.0, 4.4, 4.2, 4.0, and 3.4.
InstanceClass	String	No	dds.mongo.2xlarge	The instance type of the instance. The instance type varies based on the instance architecture. For more information about instance types supported by different instance architectures, see the following topics: Standalone instance types Replica set instance types Sharded cluster instance types
VpcId	String	No	vpc-bp1nme44gek34slfc****	The ID of the virtual private cloud (VPC).
VSwitchId	String	No	vsw-bp1e7clcw529l773d****	The ID of the vSwitch.
InstanceType	String	No	replicate	The category 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 under this account is queried.
ZoneId	String	No	cn-hangzhou-b	The ID of the zone.
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
TotalCount	String	1	The number of instances in the query result.
RequestId	String	52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA	The ID of the request.
DBInstances	Array of DBInstance		Details about the instances.
CreationTime	String	2022-01-05T03:18:53Z	The time when the instance was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
ExpireTime	String	2022-02-05T16:00Z	The time when the instance expires. The time is in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.
Tags	Array of Tag		The tags of the instance.
Key	String	testdatabase	The key of tag N of the instance. Valid values of N: 1 to 20. The key cannot start with `aliyun`, `acs:`, `http://`, or `https://`. The key can be up to 64 characters in length. The key cannot be an empty string.
Value	String	apitest	The value of tag N 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. The value can be an empty string.
LastDowngradeTime	String	2021-05-08	The last time when the instance was downgraded.
ShardList	Array of ShardAttribute		Details about the shard node. Note This parameter is returned if the instance is a sharded cluster instance.
NodeClass	String	dds.shard.mid	The instance type of the shard node.
NodeDescription	String	Test shard node	The description of the shard node.
NodeStorage	Integer	10	The storage capacity of the shard node. Unit: GB.
NodeId	String	d-bp1cac6f2083****	The ID of the shard node.
ReadonlyReplicas	Integer	2	The number of read-only nodes in the shard node. Valid values: 0 to 5.
DBInstanceType	String	replicate	The category of the instance. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance
DestroyTime	String	2021-12-10T16:00:00Z	The time when the instance data was destroyed. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
ChargeType	String	PrePaid	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go
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 the China site (aliyun.com).
VpcAuthMode	String	Open	Indicates whether password-free access within a VPC is enabled. Valid values: Open: Password-free access is enabled. Close: Password-free access is disabled.
DBInstanceStatus	String	Running	The state of the instance. For more information about valid values, see Instance states.
NetworkType	String	VPC	The network type of the instance. Valid values: Classic VPC
LockMode	String	Unlock	Indicates whether the instance is locked. Valid values: Unlock: The instance is not locked. ManualLock: The cluster 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 capacity 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 an extended period of time.
EngineVersion	String	4.2	The database engine version of the instance.
MongosList	Array of MongosAttribute		Details about the mongos node. Note This parameter is returned if the instance is a sharded cluster instance.
NodeClass	String	dds.mongos.standard	The type of the mongos node.
NodeDescription	String	Test mongos node	The description of the mongos node.
NodeId	String	s-bp10e3b0d02f****	The ID of the mongos node.
RegionId	String	cn-hangzhou	The region ID of the instance.
DBInstanceStorage	Integer	20	The storage capacity of the instance.
ResourceGroupId	String	rg-acfm22cdcgc****	The ID of the resource group.
ZoneId	String	cn-hangzhou-i	The zone ID of the instance.
DBInstanceId	String	dds-bp12c5b040dc****	The ID of the instance.
DBInstanceClass	String	dds.mongo.mid	The instance type of the instance. The instance type varies based on the instance architecture. For more information about instance types supported by different instance architectures, see the following topics: Standalone instance types Replica set instance types Sharded cluster instance types
Engine	String	MongoDB	The database engine of the instance. Set the value to MongoDB.
ReplicationFactor	String	3	The number of nodes in the instance. Note This parameter is returned if the instance is a replica set instance.
DBInstanceDescription	String	test database	The description of the instance.
KindCode	String	0	The kind code of the instance. Valid values: 0: physical machine 1: Elastic Compute Service (ECS) instance 2: Docker cluster 18: Kubernetes cluster

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstancesOverview
&RegionId=cn-hangzhou
&InstanceIds=dds-bp12c5b040dc****
&Common request parameters

Sample success responses

XML format

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

<DescribeDBInstancesOverviewResponse>
    <TotalCount>1</TotalCount>
    <RequestId>52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA</RequestId>
    <DBInstances>
        <EngineVersion>4.2</EngineVersion>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <ResourceGroupId>rg-acfm22cdcgc****</ResourceGroupId>
        <ZoneId>cn-hangzhou-i</ZoneId>
        <ReplicationFactor>3</ReplicationFactor>
        <CapacityUnit/>
        <DBInstanceClass>dds.mongo.mid</DBInstanceClass>
        <DBInstanceType>replicate</DBInstanceType>
        <LockMode>Unlock</LockMode>
        <DBInstanceId>dds-bp12c5b040dc****</DBInstanceId>
        <ChargeType>PrePaid</ChargeType>
        <NetworkType>VPC</NetworkType>
        <DBInstanceStorage>20</DBInstanceStorage>
        <CreationTime>2022-01-05T03:18:53Z</CreationTime>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2022-02-05T16:00Z</ExpireTime>
        <KindCode>0</KindCode>
        <Engine>MongoDB</Engine>
        <DBInstanceDescription>Test database</DBInstanceDescription>
    </DBInstances>
</DescribeDBInstancesOverviewResponse>

JSON format

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

{
  "TotalCount" : 1,
  "RequestId" : "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances" : [ {
    "EngineVersion" : "4.2",
    "DBInstanceStatus" : "Running",
    "ResourceGroupId" : "rg-acfm22cdcgc****",
    "ZoneId" : "cn-hangzhou-i",
    "ReplicationFactor" : "3",
    "CapacityUnit" : "",
    "DBInstanceClass" : "dds.mongo.mid",
    "DBInstanceType" : "replicate",
    "LockMode" : "Unlock",
    "DBInstanceId" : "dds-bp12c5b040dc****",
    "ChargeType" : "PrePaid",
    "NetworkType" : "VPC",
    "DBInstanceStorage" : 20,
    "CreationTime" : "2022-01-05T03:18:53Z",
    "RegionId" : "cn-hangzhou",
    "ExpireTime" : "2022-02-05T16:00Z",
    "KindCode" : 0,
    "Engine" : "MongoDB",
    "DBInstanceDescription": "Test database"
  } ]
}

Error codes

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