DescribeDBInstanceAttribute - - Alibaba Cloud Documentation Center

Queries the details of an ApsaraDB for MongoDB instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeDBInstanceAttribute

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Engine	string	No	The database engine. Set the value to MongoDB.	MongoDB
DBInstanceId	string	Yes	The instance ID.	dds-bp11483712c1****
ResourceGroupId	string	No	The resource group ID. For more information, see View the basic information about a resource group. Note This parameter is available only if you use the China site (aliyun.com).	rg-acfmyiu4ekp****
IsDelete	boolean	No	Specifies whether the instance is deleted. Valid values: false: The instance is running normally. The system queries the information of the running instance. true: The instance is deleted. The system queries the information of the deleted instance.	false

Response parameters

Parameter	Type	Description	Example
	object	The information of the instance.
RequestId	string	The unique ID of the request.	A935A8EE-A6CC-53DE-98BA-20ABAA7E632B
DBInstances	object	The database instance information.
DBInstance	array
	object	The details of the instance.
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-02T07:43:59Z
ReplicaSets	object
ReplicaSet	array	The details of the replica set instance. Note This parameter is returned if the instance is a replica set instance.
	object	The details of the replica set instance. Note This parameter is returned if the instance is a replica set instance.
VSwitchId	string	The vSwitch ID. Note This parameter is returned if the network type is VPC.	vpc-bp1jk5vwkcri27qme****
ConnectionPort	string	The port number that is used to connect to the node.	3717
ReplicaSetRole	string	The role of the node. Valid values: Primary: primary node. Secondary: secondary node.	Primary
ConnectionDomain	string	The endpoint of the node.	dds-bp11483712c1****.mongodb.rds.aliyuncs.com
VPCCloudInstanceId	string	The ID of the node in the replica set instance deployed in a VPC. Note This parameter is returned if the network type of the instance is VPC.	dds-bp11483712c1****
NetworkType	string	The network type of the instance. Valid values: Classic: classic network. VPC: virtual private cloud (VPC).	VPC
VPCId	string	The ID of the VPC. Note This parameter is returned if the network type of the instance is VPC.	vpc-bp1jk5vwkcri27qme****
ReplacateId	string	The logical ID of the global active-active instance. Note MongoDB does not support the purchase of this type of instance. This parameter applies only to earlier versions of global active-active instances.	bls-m****
Tags	object
Tag	array	The details of the instance tag.
	object
Key	string	The tag key.	test
Value	string	The tag value.	api
VpcAuthMode	string	Indicates whether password-free access within the VPC is enabled. Valid values: Open: Password-free access within the VPC is enabled. Close: Password-free access within the VPC is disabled. You must use a password to access the instance. NotSupport: The feature is not supported.	Open
NetworkType	string	The network type of the instance. Valid values: Classic: classic network. VPC: virtual private cloud (VPC).	VPC
LockMode	string	The lock status of the instance. 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 when the storage space is full.	Unlock
EngineVersion	string	The database engine version.	4.4
MaxIOPS	integer	The maximum IOPS of the instance.	1000
MaxMBPS	integer	The maximum disk throughput of the instance. Unit: MB/s.	350
VPCCloudInstanceIds	string	The IDs of the nodes in the replica set instance deployed in a VPC. Note This parameter is returned if the network type of the instance is VPC. Important This parameter is deprecated	dds-bp11483712c1****
MongosList	object
MongosAttribute	array	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.
VpcCloudInstanceId	string	The ID of the mongos node in the sharded cluster instance deployed in a VPC.	s-bp1d8c262a158****
LockMode	string	The lock status of the instance. 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 when the storage space is full.	Unlock
MaxIOPS	integer	The maximum IOPS of the mongos node.	800
VSwitchId	string	The vSwitch ID. Note This parameter is returned if the network type of the instance is VPC.	vsw-bp1vj604nj5a9zz74****
NodeClass	string	The instance type of the mongos node.	dds.mongos.mid
MaxConnections	integer	The maximum number of connections to the mongos node.	1000
Port	integer	The port number that is used to connect to the mongos node.	3717
VPCId	string	The ID of the VPC. Note This parameter is returned if the network type of the instance is VPC.	vpc-bp1n3i15v90el48nx****
ConnectSting	string	The endpoint of the mongos node. Warning This parameter will be deprecated. Please use the ConnectString parameter instead	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
NodeDescription	string	The name of the mongos node.	mongos1
NodeId	string	The ID of the mongos node.	s-bp1d8c262a15****
Status	string	The status of the mongos node. For more information, see Instance states.	Running
CurrentKernelVersion	string	The kernel minor version number of the mongos node.	mongodb_20220518_4.0.21
ConnectString	string	The endpoint of the mongos node.	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
ProtocolType	string	The access protocol type of the instance. Valid values: mongodb: MongoDB protocol. dynamodb: DynamoDB protocol. Note This parameter is returned if the instance is a sharded cluster instance.	mongodb
DBInstanceDescription	string	The name of the instance.	Test database
CurrentKernelVersion	string	The minor version of the current database in the instance.	5.0.5-20220721143518_0
DBInstanceReleaseProtection	boolean	Indicates whether release protection is enabled for the instance. Valid values: true: Release protection is enabled. false: Release protection is disabled.	false
ExpireTime	string	The expiration time of the subscription instance. The time follows the ISO 8601 standard 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.	2022-02-05T16:00Z
MaintainStartTime	string	The start time of the maintenance window for the instance. The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.	18:00Z
DBInstanceType	string	The architecture of the instance. Valid values: replicate: replica set instance. sharding: sharded cluster instance.	replicate
LastDowngradeTime	string	The date when the last downgrade operation was performed on the instance.	2022-01-08
ShardList	object
ShardAttribute	array	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.
LockMode	string	The lock mode of the sharded cluster instance. 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 when the storage space is full.	Unlock
MaxIOPS	integer	The maximum IOPS of the shard node.	8000
ConnectString	string	The endpoint of the shard node.	d-bp1af0680a9c6d3**.mongodb.rds.aliyuncs.com:**
NodeClass	string	The instance type of the shard node.	dds.shard.mid
MaxConnections	integer	The maximum number of connections to the shard node.	8000
Port	integer	The port number that is used to connect to the shard node.	3717
NodeDescription	string	The name of the shard node.	testshard
NodeId	string	The ID of the shard node.	d-bp16e09d9c5d****
NodeStorage	integer	The storage capacity of the shard node. Unit: GB.	10
ReadonlyReplicas	integer	The number of read-only nodes in the shard node. Valid values: 0 to 5 (integer).	0
Status	string	The status of the shard node. For more information, see Instance states.	Running
MaxDiskMbps	string	The maximum disk throughput of the shard node.	350
CurrentKernelVersion	string	The kernel minor version number of the shard node.	mongodb_20230613_4.0.25
ReplicaSetName	string	The name of the shard node.	mgset-xxxx
MaintainEndTime	string	The end time of the maintenance window for the instance. The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.	03:00Z
DBInstanceStatus	string	The status of the instance. For more information, see Instance states.	Running
VPCId	string	The ID of the VPC. Note This parameter is returned if the network type of the instance is VPC.	vpc-bp1n3i15v90el48nx****
RegionId	string	The region ID of the instance.	cn-hangzhou
DBInstanceStorage	integer	The storage capacity of the instance.	10
ReplicaSetName	string	The name of the replica set instance. Note This parameter is returned if the instance is a replica set instance.	mgset-10ace****
VSwitchId	string	The vSwitch ID. Note This parameter is returned if the network type of the instance is VPC.	vsw-bp1oo2a7isyrb8igf****
StorageEngine	string	The storage engine of the instance.	WiredTiger
ConfigserverList	object
ConfigserverAttribute	array	The details of the ConfigServer node. Note This parameter is returned if the instance is a sharded cluster instance.
	object	The details of the ConfigServer node. Note This parameter is returned if the instance is a sharded cluster instance.
MaxIOPS	integer	The maximum IOPS of the ConfigServer node.	1000
LockMode	string	The lock status of the instance. 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 when the storage space is full.	Unlock
ConnectString	string	The endpoint of the Configserver node.	dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
NodeClass	string	The instance type of the Configserver node.	dds.cs.mid
MaxConnections	integer	The maximum number of connections to the ConfigServer node.	1000
Port	integer	The port number that is used to connect to the Configserver node.	3717
NodeDescription	string	The name of the Configserver node.	testConfigserver
NodeId	string	The ID of the Configserver node.	dds-bp11483712c1****-cs
NodeStorage	integer	The storage capacity of the Configserver node. Unit: GB.	20
Status	string	The status of the ConfigServer node. For more information, see Instance states.	Running
CurrentKernelVersion	string	The kernel minor version number of the ConfigServer node.	mongodb_20230613_4.0.25
ResourceGroupId	string	The ID of the resource group to which the instance belongs. Note This parameter is returned only if you use the China site (aliyun.com).	rg-acfmyiu4ekp****
ZoneId	string	The zone ID of the instance.	cn-hangzhou-b
MaxConnections	integer	The maximum number of connections to the instance.	500
DBInstanceId	string	The instance ID.	dds-bp11483712c1****
DBInstanceClass	string	The instance type.	dds.mongo.mid
Engine	string	The database engine of the instance.	MongoDB
ReadonlyReplicas	string	The number of read-only nodes in the instance.	1
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: local disk instance. 3: standalone instance. 18: cloud disk instance.	1
CapacityUnit	string	The I/O throughput consumed by the instance.	100
ChargeType	string	The billing method of the instance. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
StorageType	string	The disk type. Valid values: cloud_essd1: ESSD PL1 cloud disk. cloud_essd2: ESSD PL2 cloud disk. cloud_essd3: ESSD PL3 cloud disk. local_ssd: SSD local disk. cloud_essd_dbfs_s: DBFS shared storage cloud disk.	cloud_essd1
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.	2021-12-10T16:00:00Z
DBInstanceOrderStatus	string	The status of the orders generated for the instance. Valid values: all_completed: All orders are in the producing state or have been completed. order_unpaid: An unpaid order exists. order_wait_for_produce: An order is being issued for production. Note The order production process is as follows: The user places an order, pays for the order, the order is issued for production, the order is being produced, and the order is completed. If the order status remains order_wait_for_produce for a long time, the order issuance process encounters an issue. The system automatically retries the operation. The instance status change only when the order is in the producing and complete state, such as changing configurations and running.	all_completed
Encrypted	boolean	Indicates whether disk encryption is enabled.	true
EncryptionKey	string	The KMS key used for disk encryption.	07609cc3-3109-408f-a35e-c548e776da0b
SyncPercent	string	The progress of data synchronization in percentage. When you are changing the configurations of the instance, you must synchronize the data of the instance. You can obtain the data synchronization progress based on the value returned for this parameter.	0.8
UseClusterBackup	boolean	Indicates whether the cluster backup mode is enabled. Valid values: true: The cluster backup mode is enabled. false: The cluster backup mode is disabled.	true
BurstingEnabled	boolean	Indicates whether performance burst is enabled for the ESSD AutoPL disk.	true
ProvisionedIops	integer	The provisioned performance.	1960
DisasterRecoveryInfo	string

Examples

Success response

JSON format

{
  "RequestId": "A935A8EE-A6CC-53DE-98BA-20ABAA7E632B",
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "ReplicaSets": {
          "ReplicaSet": [
            {
              "VSwitchId": "vpc-bp1jk5vwkcri27qme****",
              "ConnectionPort": "3717",
              "ReplicaSetRole": "Primary",
              "ConnectionDomain": "dds-bp11483712c1****.mongodb.rds.aliyuncs.com",
              "VPCCloudInstanceId": "dds-bp11483712c1****",
              "NetworkType": "VPC",
              "VPCId": "vpc-bp1jk5vwkcri27qme****"
            }
          ]
        },
        "ReplacateId": "bls-m****",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Open",
        "NetworkType": "VPC",
        "LockMode": "Unlock",
        "EngineVersion": "4.4",
        "MaxIOPS": 1000,
        "MaxMBPS": 350,
        "VPCCloudInstanceIds": "dds-bp11483712c1****",
        "MongosList": {
          "MongosAttribute": [
            {
              "VpcCloudInstanceId": "s-bp1d8c262a158****",
              "LockMode": "Unlock",
              "MaxIOPS": 800,
              "VSwitchId": "vsw-bp1vj604nj5a9zz74****",
              "NodeClass": "dds.mongos.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "VPCId": "vpc-bp1n3i15v90el48nx****",
              "ConnectSting": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
              "NodeDescription": "mongos1",
              "NodeId": "s-bp1d8c262a15****",
              "Status": "Running",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21",
              "ConnectString": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com"
            }
          ]
        },
        "ProtocolType": "mongodb",
        "DBInstanceDescription": "Test database\n",
        "CurrentKernelVersion": "5.0.5-20220721143518_0",
        "DBInstanceReleaseProtection": false,
        "ExpireTime": "2022-02-05T16:00Z",
        "MaintainStartTime": "18:00Z",
        "DBInstanceType": "replicate",
        "LastDowngradeTime": "2022-01-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "LockMode": "Unlock",
              "MaxIOPS": 8000,
              "ConnectString": "d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****",
              "NodeClass": "dds.shard.mid",
              "MaxConnections": 8000,
              "Port": 3717,
              "NodeDescription": "testshard",
              "NodeId": "d-bp16e09d9c5d****",
              "NodeStorage": 10,
              "ReadonlyReplicas": 0,
              "Status": "Running",
              "MaxDiskMbps": "350",
              "CurrentKernelVersion": "mongodb_20230613_4.0.25",
              "ReplicaSetName": "mgset-xxxx"
            }
          ]
        },
        "MaintainEndTime": "03:00Z",
        "DBInstanceStatus": "Running",
        "VPCId": "vpc-bp1n3i15v90el48nx****",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 10,
        "ReplicaSetName": "mgset-10ace****",
        "VSwitchId": "vsw-bp1oo2a7isyrb8igf****",
        "StorageEngine": "WiredTiger",
        "ConfigserverList": {
          "ConfigserverAttribute": [
            {
              "MaxIOPS": 1000,
              "LockMode": "Unlock",
              "ConnectString": "dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com",
              "NodeClass": "dds.cs.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "NodeDescription": "testConfigserver",
              "NodeId": "dds-bp11483712c1****-cs",
              "NodeStorage": 20,
              "Status": "Running",
              "CurrentKernelVersion": "mongodb_20230613_4.0.25"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-b",
        "MaxConnections": 500,
        "DBInstanceId": "dds-bp11483712c1****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReadonlyReplicas": "1",
        "ReplicationFactor": "3",
        "KindCode": "1",
        "CapacityUnit": "100",
        "ChargeType": "PostPaid",
        "StorageType": "cloud_essd1",
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceOrderStatus": "all_completed",
        "Encrypted": true,
        "EncryptionKey": "07609cc3-3109-408f-a35e-c548e776da0b",
        "SyncPercent": "0.8",
        "UseClusterBackup": true,
        "BurstingEnabled": true,
        "ProvisionedIops": 1960,
        "DisasterRecoveryInfo": ""
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	VpcCloudInstanceIdNumError	Get vpcCloudInstanceId number error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.