DescribeDBInstanceAttribute - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the details of an instance.

Operation Description

Supported database engines

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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
rds:DescribeDBInstanceAttribute	READ	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance. Warning**: Do not query the details of multiple instances at a time by using multiple instance IDs. Otherwise, the query times out and fails.	rm-uf6wjk5*****
Expired	string	No	Specifies whether the instance expires. Valid values: True: The instance expires. False: The instance does not expire.	False

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	object []	An array that consists of the details about the instance.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-*****
CreationTime	string	The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2011-05-30T12:11:04Z
IncrementSourceDBInstanceId	string	The ID of the instance from which the incremental data comes. The incremental data of a disaster recovery instance or read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.	rm-uf6wjk5*****
MaintainTime	string	The maintenance window of the instance. The time is displayed in UTC. Take note that the maintenance window displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.	00:00Z-02:00Z
PayType	string	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Postpaid
AvailabilityValue	string	The availability status of the instance in percentage.	100.0%
EngineVersion	string	The database engine version of the serverless instance.	5.5
DedicatedHostGroupId	string	The ID of the dedicated cluster.	dhg-7a9*****
ConnectionString	string	The internal endpoint of the instance.	rm-uf6wjk5*****.mysql.rds.aliyuncs.com
SuperPermissionMode	string	Indicates whether the instance supports privileged accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account. Enable: Privileged accounts are supported. Disabled: Privileged accounts are not supported.	Disabled
InstanceNetworkType	string	The network type of the instance. Valid values: Classic VPC	Classic
MasterInstanceId	string	The ID of the primary instance. Description** If this parameter is not returned, the instance is the primary instance.	rm-uf6wjk5*****
AutoUpgradeMinorVersion	string	The method that is used to update the minor engine version of the instance. Valid values: Auto: automatic update. Manual: manual update. The minor engine version of the instance is forcefully updated only when the in-use minor engine version is phased out.	Auto
ExpireTime	string	The expiration time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Description** Pay-as-you-go instances never expire.	2019-03-27T16:00:00Z
AccountMaxQuantity	integer	The maximum number of accounts that can be created on the instance.	50
MasterZone	string	The zone ID of the primary instance.	5454284
GuardDBInstanceId	string	The ID of the disaster recovery instance that is attached to the instance.	rm-uf64zsu*****
DBInstanceStorage	integer	The storage capacity of the instance. Unit: GB.	10
TimeZone	string	The time zone of the instance.	Central Standard Time
LatestKernelVersion	string	The latest minor engine version that is supported by the instance.	rds_20201031
TipsLevel	integer	The severity level of the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values: 1: The instance is normal. 2: The specifications of the read-only instances do not match the specifications of the primary instance, and the performance is affected. You must adjust the specifications of these instances based on your business requirements.	1
ZoneId	string	The zone ID of the instance.	cn-hangzhou-a
MaxConnections	integer	The maximum number of concurrent connections.	60
DBInstanceId	string	The instance ID.	rm-uf6wjk5*****
TempDBInstanceId	string	The ID of the temporary instance that is attached to the instance.	rm-uf64zsu*****
AdvancedFeatures	string	The advanced features that are enabled for the instance. If multiple advanced features are enabled, the advanced features are separated by commas (,). This parameter is available only to instances that run SQL Server. Valid values: LinkedServer DistributeTransaction	LinkedServer
DBInstanceStorageType	string	The storage type of the instance. Valid values: local_ssd and ephemeral_ssd: local SSD cloud_ssd: standard SSD cloud_essd: enhanced SSD (ESSD)	local_ssd
DBInstanceMemory	long	The memory capacity of the instance. Unit: MB.	4096
IPType	string	The type of the IP address. Only IPv4 addresses are supported.	IPv4
ConsoleVersion	string	The type of the proxy that is used by the instance. Valid values: 1: shared proxy 2: dedicated proxy Note We recommend that you use the ProxyType parameter instead of this parameter.	2
ConnectionMode	string	The connection mode of the instance. Valid values: Standard: standard mode Safe: database proxy mode	Standard
Port	string	The port that is used to connect to the instance over an internal network.	3306
LockMode	string	The lock mode of the instance. 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 due to instance restoration. LockByDiskQuota: The instance is automatically locked due to exhausted storage. LockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically locked due to exhausted storage.	Unlock
GeneralGroupName	string	The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.	TestGroup
VpcCloudInstanceId	string	The VPC ID.	vpc-23rsxdf*****
Collation	string	The character set collation of the instance.	Chinese_PRC_CI_AS
MaxIOPS	integer	The maximum number of I/O requests per second.	150
MaxIOMBPS	integer	The maximum I/O throughput. Unit: MB/s.	0MB/s
Tips	string	The information about the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.	The IP addresses in the IP address whitelist.
SecurityIPList	string	The IP addresses in the IP address whitelist.	192.168.XX.XX/24
SecurityIPMode	string	The whitelist mode of the instance. Valid values: normal: standard whitelist mode safety: enhanced whitelist mode	normal
DBInstanceClassType	string	The instance family to which the instance belongs. Valid values: s: shared instance family x: general-purpose instance family d: dedicated instance family h: dedicated host instance family	s
ProxyType	integer	The type of the proxy that is supported by the instance. Valid values: 0: The instance does not support database proxies. 1: The instance supports shared proxies, with which the instance runs in multi-tenant mode. 2: The instance supports dedicated proxies, with which the instance runs in single-tenant mode.	1
CurrentKernelVersion	string	The version of the database engine.	rds_20181010
DBInstanceDescription	string	The description of the instance.	The number of cores that are configured for the instance.
DBInstanceCPU	string	The number of CPU cores.	2
DBInstanceNetType	string	The type of the network over which the instance is connected. Valid values: Internet: Internet Intranet: internal network	Internet
DBInstanceType	string	The type of the instance. Valid values: Primary: primary instance Readonly: read-only instance Guard: disaster recovery instance Temp: temporary instance	Primary
LockReason	string	The reason why the instance was locked.	instance_expired
DBInstanceStatus	string	The status of the instance. For more information, see Instance states.	Running
DBMaxQuantity	integer	The maximum number of databases that can be created on the instance.	200
RegionId	string	The region ID.	cn-hangzhou
ReadonlyInstanceSQLDelayedTime	string	The latency at which the system replicates data to read-only instances. The system replicates data from the primary instance to the read-only instances at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter. Unit: seconds.	30
VSwitchId	string	The vSwitch ID.	vsw-*****
ResourceGroupId	string	The resource group ID.	rg-acfmy*****
Category	string	The RDS edition of the instance. Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition cluster: RDS Cluster Edition for MySQL AlwaysOn: RDS Cluster Edition for SQL Server Finance: RDS Enterprise Edition Serverless_basic: RDS Serverless Basic Edition	Basic
DBInstanceClass	string	The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types.	rds.mys2.small
Engine	string	The database engine of the instance. Valid values: MySQL PostgreSQL SQLServer MariaDB	MySQL
SlaveZones	object []	Information about the zone of the secondary instance.
ZoneId	string	The zone ID.	cn-hangzhou-a
ReadOnlyDBInstanceIds	object []	The IDs of the read-only instances that are attached to the primary instance.
DBInstanceId	string	The ID of the read-only instance.	rm-bp*****
Extra	object	The extended information of the instance.
DBInstanceIds	array	The IDs of the instances.
	string	The instance ID.	rm-uf6wjk5*****
DeletionProtection	boolean	Indicates whether the release protection feature is enabled. Valid values: true: The feature is enabled. false: The feature is disabled.	true
ServerlessConfig	object	The settings of the serverless instance.
ScaleMin	double	The minimum number of RDS Capacity Units (RCUs).	0.5
ScaleMax	double	The maximum number of RCUs.	8
AutoPause	boolean	Indicates whether the automatic start and stop feature is enabled for the serverless instance. Valid values: true: The feature is enabled. false (default): The feature is disabled. Note After the automatic suspension feature is enabled, if no connections to the instance are established within 10 minutes, the instance is suspended. After a connection to the instance is established, the instance is automatically resumed.	true
SwitchForce	boolean	Indicates whether the forced scaling feature is enabled for the serverless instance. true: The feature is enabled. false (default): The feature is disabled. Note In most cases, ApsaraDB RDS automatically scales in or out the RCUs of a serverless instance based on business requirements in real time. In rare cases, the scaling does not take effect in real time. You can enable the forced scaling feature to forcefully scales in or out the RCUs of the instance.	false
BabelfishConfig	object	The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance. Note This parameter is suitable only for ApsaraDB RDS for PostgreSQL instances for which Babelfish is enabled. For more information, see Introduction to Babelfish.
BabelfishEnabled	string	The switch to enable or disable Babelfish. Note If Babelfish is enabled when you purchase an ApsaraDB RDS for PostgreSQL instance, this parameter is fixed as true.	true
MigrationMode	string	The migration mode for Babelfish. Valid values: single-db multi-db Note For more information about migration modes for Babelfish, see Migration modes.	single-db
kindCode	string	An internal parameter. You can ignore this parameter.	The architecture type of the instance. Valid values: - x86 - arm
InstructionSetArch	string	The architecture type of the instance. Valid values: x86 arm	x86
DBClusterNodes	object []	The information about the node in the cluster.
NodeRegionId	string	The region ID.	cn-beijing
NodeZoneId	string	The zone ID.	cn-beijing-h
NodeId	string	The node ID.	rn-****
NodeRole	string	The role of the node. Valid values: primary: primary node secondary: secondary node	primary
ClassCode	string	The specification of the node.	mysql.n2.medium.xc
BurstingEnabled	boolean	An invalid parameter. You can ignore this parameter.	false
BpeEnabled	string	An invalid parameter. You can ignore this parameter.	false
PGBouncerEnabled	string	Indicates whether PgBouncer is enabled. Note This parameter is returned only for RDS instances that run PostgreSQL. If PgBouncer is enabled, the return value is true.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-*****",
        "CreationTime": "2011-05-30T12:11:04Z",
        "IncrementSourceDBInstanceId": "rm-uf6wjk5*****",
        "MaintainTime": "00:00Z-02:00Z",
        "PayType": "Postpaid",
        "AvailabilityValue": "100.0%",
        "EngineVersion": "5.5",
        "DedicatedHostGroupId": "dhg-7a9*****",
        "ConnectionString": "rm-uf6wjk5*****.mysql.rds.aliyuncs.com",
        "SuperPermissionMode": "Disabled",
        "InstanceNetworkType": "Classic",
        "MasterInstanceId": "rm-uf6wjk5*****",
        "AutoUpgradeMinorVersion": "Auto",
        "ExpireTime": "2019-03-27T16:00:00Z",
        "AccountMaxQuantity": 50,
        "MasterZone": "5454284",
        "GuardDBInstanceId": "rm-uf64zsu*****",
        "DBInstanceStorage": 10,
        "TimeZone": "Central Standard Time",
        "LatestKernelVersion": "rds_20201031",
        "TipsLevel": 1,
        "ZoneId": "cn-hangzhou-a",
        "MaxConnections": 60,
        "DBInstanceId": "rm-uf6wjk5*****",
        "TempDBInstanceId": "rm-uf64zsu*****",
        "AdvancedFeatures": "LinkedServer",
        "DBInstanceStorageType": "local_ssd",
        "DBInstanceMemory": 4096,
        "IPType": "IPv4",
        "ConsoleVersion": "2",
        "ConnectionMode": "Standard",
        "Port": "3306",
        "LockMode": "Unlock",
        "GeneralGroupName": "TestGroup",
        "VpcCloudInstanceId": "vpc-23rsxdf*****",
        "Collation": "Chinese_PRC_CI_AS",
        "MaxIOPS": 150,
        "MaxIOMBPS": 0,
        "Tips": "The IP addresses in the IP address whitelist.\n",
        "SecurityIPList": "192.168.XX.XX/24",
        "SecurityIPMode": "normal",
        "DBInstanceClassType": "s",
        "ProxyType": 1,
        "CurrentKernelVersion": "rds_20181010",
        "DBInstanceDescription": "The number of cores that are configured for the instance.\n",
        "DBInstanceCPU": "2",
        "DBInstanceNetType": "Internet",
        "DBInstanceType": "Primary",
        "LockReason": "instance_expired",
        "DBInstanceStatus": "Running",
        "DBMaxQuantity": 200,
        "RegionId": "cn-hangzhou ",
        "ReadonlyInstanceSQLDelayedTime": "30",
        "VSwitchId": "vsw-*****",
        "ResourceGroupId": "rg-acfmy*****",
        "Category": "Basic",
        "DBInstanceClass": "rds.mys2.small",
        "Engine": "MySQL",
        "SlaveZones": {
          "SlaveZone": [
            {
              "ZoneId": "cn-hangzhou-a"
            }
          ]
        },
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rm-bp*****"
            }
          ]
        },
        "Extra": {
          "DBInstanceIds": {
            "DBInstanceId": [
              "rm-uf6wjk5*****"
            ]
          }
        },
        "DeletionProtection": true,
        "ServerlessConfig": {
          "ScaleMin": 0.5,
          "ScaleMax": 8,
          "AutoPause": true,
          "SwitchForce": false
        },
        "BabelfishConfig": {
          "BabelfishEnabled": "true",
          "MigrationMode": "single-db"
        },
        "kindCode": "The architecture type of the instance. Valid values:\n\n- **x86**\n- **arm**",
        "InstructionSetArch": "x86",
        "DBClusterNodes": {
          "DBClusterNode": [
            {
              "NodeRegionId": "cn-beijing",
              "NodeZoneId": "cn-beijing-h",
              "NodeId": "rn-****",
              "NodeRole": "primary",
              "ClassCode": "mysql.n2.medium.xc"
            }
          ]
        },
        "BurstingEnabled": false,
        "BpeEnabled": "false",
        "PGBouncerEnabled": "true"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ConnectTimeoutRetryLater	Connect timeout retry later.	The connection timed out. Please try again later.
400	TimeoutRetryLater	Timeout, please retry later.	-
400	DataNotExist	Data not exist.	No data is available.

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

Change history

Change time

Summary of changes

Operation

2023-06-27

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-09-01

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-07-05

API Description Update,The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
API Description	API Description Update
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-02-28

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-02-28

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-02-28

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-02-28

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.

2022-02-28

The error codes of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.