Query instance details - ApsaraDB RDS - Alibaba Cloud Documentation Center

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	DescribeDBInstanceAttribute	The operation that you want to perform. Set the value to DescribeDBInstanceAttribute.
DBInstanceId	String	Yes	rm-uf6wjk5*****	The ID of the instance. You can specify up to 30 instance IDs in a single request. If you specify multiple instance IDs, separate the instance IDs with commas (,).
Expired	String	No	False	Specifies whether the instance expires. Valid values: True: The instance expires. False: The instance does not expire.

Response parameters


Parameter	Type	Example	Description
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	The ID of the request.
Items	Array of DBInstanceAttribute		An array that consists of the details about the instance.
DBInstanceAttribute
VpcId	String	vpc-*****	The ID of the virtual private cloud (VPC) to which the instance belongs.
CreationTime	String	2011-05-30T12:11:04Z	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.
IncrementSourceDBInstanceId	String	rm-uf6wjk5*****	The ID of the instance from which 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.
MaintainTime	String	00:00Z-02:00Z	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.
PayType	String	Postpaid	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription
AvailabilityValue	String	100.0%	The availability status of the instance in percentage.
EngineVersion	String	5.5	The database engine version of the instance.
DedicatedHostGroupId	String	dhg-7a9*****	The ID of the dedicated cluster to which the instance belongs.
ConnectionString	String	rm-uf6wjk5*****.mysql.rds.aliyuncs.com	The internal endpoint of the instance.
SuperPermissionMode	String	Disabled	Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account. Enable: Superuser accounts are supported. Disabled: Superuser accounts are not supported.
InstanceNetworkType	String	Classic	The network type of the instance. Valid values: Classic VPC
MasterInstanceId	String	rm-uf6wjk5*****	The ID of the primary instance. Note If this parameter is not returned, the instance is the primary instance.
AutoUpgradeMinorVersion	String	Auto	The method that is used to update the minor engine version of the instance. Valid values: Auto: automatic update. Manual: manual update. ApsaraDB RDS automatically updates the minor engine version of the instance only when the minor engine version is phased out.
ExpireTime	String	2019-03-27T16:00:00Z	The time at which the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note Pay-as-you-go instances never expire.
AccountMaxQuantity	Integer	50	The maximum number of accounts that can be created on an instance.
MasterZone	String	5454284	The ID of the primary zone.
GuardDBInstanceId	String	rm-uf64zsu*****	The ID of the disaster recovery instance that is attached to the instance.
DBInstanceStorage	Integer	10	The storage capacity of the instance. Unit: GB.
TimeZone	String	Central Standard Time	The time zone of the instance.
LatestKernelVersion	String	rds_20201031	The latest minor engine version that is supported by the instance.
TipsLevel	Integer	1	The severity level of the exception that is detected on the instance. This parameter is returned only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster. Valid values: 1: The instance is normal. 2: The specifications of the read-only instances do not match the specifications of the primary instance. You must adjust the specifications of these instances based on your business requirements.
ZoneId	String	cn-hangzhou-a	The ID of the zone to which the instances belong.
MaxConnections	Integer	60	The maximum number of concurrent connections that are allowed by the instance.
DBInstanceId	String	rm-uf6wjk5*****	The ID of the instance.
TempDBInstanceId	String	rm-uf64zsu*****	The ID of the temporary instance that is attached to the instance.
AdvancedFeatures	String	LinkedServer	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
DBInstanceStorageType	String	local_ssd	The storage type of the instance. Valid values: local_ssd and ephemeral_ssd: local SSD cloud_ssd: standard SSD cloud_essd: enhanced SSD (ESSD)
DBInstanceMemory	Long	4096	The memory size of the instance. Unit: MB.
IPType	String	IPv4	The type of the IP address that is used by the instance. The value is fixed as IPv4.
ConsoleVersion	String	2	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.
ConnectionMode	String	Standard	The connection mode of the instance. Valid values: Standard: standard mode Safe: proxy mode
Port	String	3306	The internal port number that is used to connect to the instance.
LockMode	String	Unlock	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 when the disk space is exhausted.
GeneralGroupName	String	TestGroup	The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster.
VpcCloudInstanceId	String	vpc-23rsxdf*****	The ID of the VPC to which the instance belongs. This parameter is returned only when the instance resides in a VPC.
Collation	String	Chinese_PRC_CI_AS	The character set collation of the instance.
MaxIOPS	Integer	150	The maximum number of I/O requests that can be processed by the instance per second.
MaxIOMBPS	Integer	0MB/s	The maximum I/O throughput. Unit: MB/s.
Tips	String	Everything is fine.	The information about the exception that is detected on the instance. This parameter is returned only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster.
SecurityIPList	String	192.168.XX.XX/24	The IP addresses in the IP address whitelist.
SecurityIPMode	String	normal	The whitelist mode of the instance. Valid values: normal: standard whitelist mode safety: enhanced whitelist mode
DBInstanceClassType	String	s	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
ProxyType	Integer	1	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.
CurrentKernelVersion	String	rds_20181010	The minor engine version of the instance.
DBInstanceDescription	String	Test database	The description of the instance.
DBInstanceCPU	String	2	The number of cores that are configured for the instance.
DBInstanceNetType	String	Internet	The type of the network over which the instance is connected. Valid values: Internet Intranet
DBInstanceType	String	Primary	The type of the instance. Valid values: Primary: primary instance Readonly: read-only instance Guard: disaster recovery instance Temp: temporary instance
LockReason	String	instance_expired	The reason why the instance was locked.
DBInstanceStatus	String	Running	The status of the instance. For more information, see Instance states.
DBMaxQuantity	Integer	200	The maximum number of databases that can be created on the instance.
RegionId	String	cn-hangzhou	The region ID of the instance.
ReadonlyInstanceSQLDelayedTime	String	30	The latency at which the read-only instances replicate data. The read-only instances replicate data from the primary instance at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter. Unit: seconds.
VSwitchId	String	vsw-*****	The ID of the vSwitch that serves the instance.
ResourceGroupId	String	rg-acfmy*****	The ID of the resource group to which the instance belongs.
Category	String	Basic	The RDS edition of the instance. Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition AlwaysOn: RDS Cluster Edition Finance: RDS Enterprise Edition
DBInstanceClass	String	rds.mys2.small	The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types.
Engine	String	MySQL	The database engine of the instance. Valid values: MySQL PostgreSQL SQLServer MariaDB
SlaveZones	Array of SlaveZone		An array that consists of the details about the secondary zones.
SlaveZone
ZoneId	String	cn-hangzhou-a	The ID of the zone.
ReadOnlyDBInstanceIds	Array of ReadOnlyDBInstanceId		An array that consists of the IDs of the read-only instances that are attached to the primary instance.
ReadOnlyDBInstanceId
DBInstanceId	String	rm-bp*****	The ID of the read-only RDS instance.
Extra	Object		The extended information of the instance.
DBInstanceIds	Array of String	rm-uf6wjk5*****	The ID of the instance.
DeletionProtection	Boolean	true	Indicates whether the release protection feature is enabled. Valid values: true: The feature is enabled. false: The feature is disabled.
ServerlessConfig	Object		The settings of the serverless instance.
ScaleMin	double	0.5	The minimum value of RDS Capacity Unit (RCU).
ScaleMax	double	8	The maximum value of RCU.
AutoPause	Boolean	true	Indicates whether the automatic suspension feature is enabled for the serverless instance. Valid values: true: The feature is enabled. false: The feature is disabled. This is the default value. 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 is established to the instance, the instance is automatically resumed.
SwitchForce	Boolean	false	Indicates whether the forced scaling feature is enabled for the serverless instance. true: The feature is enabled. false: The feature is disabled. This is the default value. 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 some 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.
BabelfishConfig	Object		The configuration of Babelfish for the instance. Note This parameter applies only to ApsaraDB RDS for PostgreSQL instances for which Babelfish is enabled. For more information, see Introduction to Babelfish.
BabelfishEnabled	String	true	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.
MigrationMode	String	single-db	The migration mode for Babelfish. Valid values: single-db multi-db Note For more information about migration modes for Babelfish, see Migration modes.
kindCode	String	None	An internal parameter. This operation does not return a value for this parameter.
InstructionSetArch	String	x86	The architecture type of the instance. Valid values: x86 arm

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5*****
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDBInstanceAttributeResponse>
    <RequestId>BD3A30D8-32E7-40CF-AAEA-6BFD4E3DC55E</RequestId>
    <Items>
        <DBInstanceAttribute>
            <DBInstanceMemory>8192</DBInstanceMemory>
            <ResourceGroupId>rg-acfmy*****</ResourceGroupId>
            <Port>3306</Port>
            <MasterZone>cn-hangzhou-h</MasterZone>
            <LatestKernelVersion>rds_20201031</LatestKernelVersion>
            <DBInstanceType>Primary</DBInstanceType>
            <ConsoleVersion>2</ConsoleVersion>
            <InstanceNetworkType>VPC</InstanceNetworkType>
            <DBInstanceClassType>x</DBInstanceClassType>
            <DBInstanceId>rm-uf6wjk5*****</DBInstanceId>
            <AutoUpgradeMinorVersion>Auto</AutoUpgradeMinorVersion>
            <DBInstanceStorage>150</DBInstanceStorage>
            <AvailabilityValue>100.0%</AvailabilityValue>
            <Engine>MySQL</Engine>
            <DBInstanceDescription>test1</DBInstanceDescription>
            <IPType>IPv4</IPType>
            <EngineVersion>8.0</EngineVersion>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <MaxConnections>2000</MaxConnections>
            <DBInstanceClass>rds.mysql.s3.large</DBInstanceClass>
            <AccountMaxQuantity>99999</AccountMaxQuantity>
            <VSwitchId>vsw-*****</VSwitchId>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <DeletionProtection>true</DeletionProtection>
            <GuardDBInstanceId>rm-uf64zsu*****</GuardDBInstanceId>
            <SupportCreateSuperAccount>No</SupportCreateSuperAccount>
            <InsId>1</InsId>
            <VpcId>vpc-*****</VpcId>
            <CurrentKernelVersion>rds_20200831</CurrentKernelVersion>
            <TempUpgradeTimeStart>2021-01-10 00:00:00</TempUpgradeTimeStart>
            <TempUpgradeTimeEnd>2021-06-18 00:00:00</TempUpgradeTimeEnd>
            <CreationTime>2020-06-17T09:03:57Z</CreationTime>
            <ConnectionMode>Standard</ConnectionMode>
            <VpcCloudInstanceId>vpc-23rsxdf*****</VpcCloudInstanceId>
            <ProxyType>2</ProxyType>
            <ConnectionString>rm-uf6wjk5*****.mysql.rds.aliyuncs.com</ConnectionString>
            <ExpireTime>2021-06-17T16:00:00Z</ExpireTime>
            <DBMaxQuantity>99999</DBMaxQuantity>
            <Category>HighAvailability</Category>
            <DBInstanceNetType>Intranet</DBInstanceNetType>
            <SuperPermissionMode/>
            <DedicatedHostGroupId/>
            <DBInstanceCPU>4</DBInstanceCPU>
            <GuardDBInstanceName>rm-m5*****</GuardDBInstanceName>
            <SecurityIPList>42.xx.xx.xx</SecurityIPList>
            <OriginConfiguration/>
            <ReadOnlyDBInstanceIds>
            </ReadOnlyDBInstanceIds>
            <SecurityIPMode>normal</SecurityIPMode>
            <MaintainTime>23:00Z-00:00Z</MaintainTime>
            <DispenseMode>MultiAVZDispenseMode</DispenseMode>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <DBInstanceStorageType>local_ssd</DBInstanceStorageType>
            <AccountType>Mix</AccountType>
            <MaxIOPS>5000</MaxIOPS>
            <SupportUpgradeAccountType>No</SupportUpgradeAccountType>
            <SlaveZones>
                <SlaveZone>
                    <ZoneId>cn-hangzhou-h</ZoneId>
                </SlaveZone>
            </SlaveZones>
            <Extra>
                <DBInstanceIds>
                </DBInstanceIds>
            </Extra>
            <ServerlessConfig/>
            <CanTempUpgrade>true</CanTempUpgrade>
            <RegionId>cn-hangzhou</RegionId>
        </DBInstanceAttribute>
    </Items>
</DescribeDBInstanceAttributeResponse>

JSON format

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

{
  "RequestId" : "BD3A30D8-32E7-40CF-AAEA-6BFD4E3DC55E",
  "Items" : {
    "DBInstanceAttribute" : {
      "DBInstanceMemory" : 8192,
      "ResourceGroupId" : "rg-acfmy*****",
      "Port" : 3306,
      "MasterZone" : "cn-hangzhou-h",
      "LatestKernelVersion" : "rds_20201031",
      "DBInstanceType" : "Primary",
      "ConsoleVersion" : 2,
      "InstanceNetworkType" : "VPC",
      "DBInstanceClassType" : "x",
      "DBInstanceId" : "rm-uf6wjk5*****",
      "AutoUpgradeMinorVersion" : "Auto",
      "DBInstanceStorage" : 150,
      "AvailabilityValue" : "100.0%",
      "Engine" : "MySQL",
      "DBInstanceDescription" : "test1",
      "IPType" : "IPv4",
      "EngineVersion" : 8,
      "DBInstanceStatus" : "Running",
      "MaxConnections" : 2000,
      "DBInstanceClass" : "rds.mysql.s3.large",
      "AccountMaxQuantity" : 99999,
      "VSwitchId" : "vsw-*****",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "DeletionProtection" : true,
      "GuardDBInstanceId" : "rm-uf64zsu*****",
      "SupportCreateSuperAccount" : "No",
      "InsId" : 1,
      "VpcId" : "vpc-*****",
      "CurrentKernelVersion" : "rds_20200831",
      "TempUpgradeTimeStart" : "2021-01-10 00:00:00",
      "TempUpgradeTimeEnd" : "2021-06-18 00:00:00",
      "CreationTime" : "2020-06-17T09:03:57Z",
      "ConnectionMode" : "Standard",
      "VpcCloudInstanceId" : "vpc-23rsxdf*****",
      "ProxyType" : 2,
      "ConnectionString" : "rm-uf6wjk5*****.mysql.rds.aliyuncs.com",
      "ExpireTime" : "2021-06-17T16:00:00Z",
      "DBMaxQuantity" : 99999,
      "Category" : "HighAvailability",
      "DBInstanceNetType" : "Intranet",
      "SuperPermissionMode" : "",
      "DedicatedHostGroupId" : "",
      "DBInstanceCPU" : 4,
      "GuardDBInstanceName" : "rm-m5*****",
      "SecurityIPList" : "42.xx.xx.xx",
      "OriginConfiguration" : "",
      "ReadOnlyDBInstanceIds" : "",
      "SecurityIPMode" : "normal",
      "MaintainTime" : "23:00Z-00:00Z",
      "DispenseMode" : "MultiAVZDispenseMode",
      "ZoneId" : "cn-hangzhou-h",
      "DBInstanceStorageType" : "local_ssd",
      "AccountType" : "Mix",
      "MaxIOPS" : 5000,
      "SupportUpgradeAccountType" : "No",
      "SlaveZones" : {
        "SlaveZone" : {
          "ZoneId" : "cn-hangzhou-h"
        }
      },
      "Extra" : {
        "DBInstanceIds" : ""
      },
      "ServerlessConfig" : "",
      "CanTempUpgrade" : true,
      "RegionId" : "cn-hangzhou"
    }
  }
}

Error codes


HTTP status code	Error code	Error message	Description
400	ConnectTimeoutRetryLater	Connect timeout retry later.	The error message returned because the connection to the instance timed out. Try again later.
400	DataNotExist	Data not exist.	The error message returned because the object you query does not exist.

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