View details of an RDS instance

Last Updated: Dec 06, 2017

Description

Show the detailed attributes of a specified instance.

Request parameters

Name Type Required? Description
Action String Yes Required parameter. Value: DescribeDBInstanceAttribute.
DBInstanceId String Yes Instance ID. Up to 30 IDs can be entered at a time, which are separated by commas (,).

Return parameters

Name Type Description
<Public Return Parameters> - For more information, see the Appendix.
Items List<DBInstanceAttribute> -

DBInstanceAttribute parameters

Name Type Description
DBInstanceId String Instance ID.
PayType String Postpaid: Pay-As-You-Go; Prepaid: Subscription.
DBInstanceType String Primary: primary instance; ReadOnly: read-only instance; Guard: disaster recovery instance; Temp: temporary instance.
Category String Basic: basic edition(single-node); Standard: standard edition (high-available); Enterprise: enterprise edition.
InstanceNetworkType String Classic: classic network; VPC: VPC network.
ConnectionMode String Performance: standard access mode; Safety: high security access mode.
RegionId String Region.
ZoneId String Zone.
ConnectionString String Connection address.
Port String Application access port.
Engine String Database type.
EngineVersion String Database version.
DBInstanceClass String Instance type.
DBInstanceMemory Long Instance memory, in the unit of MB.
DBInstanceStorage Integer Instance storage space, in the unit of GB.
DBInstanceNetType String Internet: public network; Intranet: private network.
DBInstanceClassType String Class Family. s: Shared DB; x: General Instance; d: Dedicated Instance; h: Dedicated Host.
DBInstanceClass String For more information, see Public parameters.
DBInstanceDescription String Instance remarks.
LockMode String
  • Unlock: normal;
  • ManualLock: locked when manually triggered;
  • LockByExpiration: automatically locked upon expiration;
  • LockByRestoration: automatically locked before instance rollback;
  • LockByDiskQuota: automatically locked when the instance space is full.
LockReason String Reason why an instance is locked.
DBMaxQuantity Integer The maximum number of databases that can be created for an instance.
AccountMaxQuantity Integer Max number of accounts that can be created.
CreationTime String Creation time, in the format of YYYY-MM-DDThh:mm:ssZ,
for example, 2011-05-30T12:11:4Z.
ExpireTime String Expiration time. Pay-As-You-Go instances never expire.
MaintainTime String Instance maintenance time.
For example, 00:00Z-02:00Z indicates that routine maintenance can be performed from 0:00 to 2:00.
AvailabilityValue String Instance availability status of the current year.
Unit: percentage.
MaxIOPS Integer The maximum number of I/O requests, that is, IOPS.
MaxConnections Integer The maximum number of concurrent connections to an instance.
MasterInstanceId String ID of the primary instance. If this parameter is not returned (that is, if it is null), the current instance is a primary instance.
IncrementSourceDBInstanceId String Instance ID of the incremental data source. For example, a disaster recovery instance’s incremental data source is a primary instance. A read-only instance’s incremental data source is a primary instance, and a primary instance’s incremental data source is NULL.
GuardDBInstanceId String If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
TempDBInstanceId String If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
ReadOnlyDBInstanceIds List<OnlyDBInstanceId> ID list of read-only instances attached to the primary instance.
SecurityIPList String Deprecated. For more information, see the DescribeDBInstanceIPArrayList interface.

Note: For information about the master/slave node information of the instance, see the DescribeDBInstanceHAConfig interface.

ReadOnlyDBInstanceId

Name Type Description
<Public Return Parameters> - For more information, see Public parameters.
DBInstanceId String ID of a read-only instance.

Example

  • Request example

    1. https://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
    2. &DBInstanceId=rdsaiiabnaiiabn
    3. &<Public Request Parameters>
  • Return example

    XML format:

    1. <CreateDBInstanceResponse>
    2. <RequestId>3C5CFDEE-F774-4DED-89A2-1D76EC63C575</RequestId>
    3. <Items>
    4. <DBInstanceAttribute>
    5. <LockMode>Unlock</LockMode>
    6. <ConnectionString>rdsfnjfqu7vjnuj.mysql.rds.aliyuncs.com </ConnectionString>
    7. <CreationTime>2014-10-10T10:28:48Z</CreationTime>
    8. <DBInstanceNetType>Internet</DBInstanceNetType>
    9. <MaxConnections>60</MaxConnections>
    10. <LockReason></LockReason>
    11. <Engine>MySQL</Engine>
    12. <AvailabilityValue>100.0%</AvailabilityValue>
    13. <AccountMaxQuantity>50</AccountMaxQuantity>
    14. <DBMaxQuantity>200</DBMaxQuantity>
    15. <RegionId>cn-hangzhou </RegionId>
    16. <ZoneId>cn-hangzhou-a</ZoneId>
    17. <ReadOnlyDBInstanceIds>
    18. <ReadOnlyDBInstanceId></ReadOnlyDBInstanceId>
    19. </ReadOnlyDBInstanceIds>
    20. <TempDBInstanceId></TempDBInstanceId>
    21. <DBInstanceMemory>240</DBInstanceMemory>
    22. <MaxIOPS>150</MaxIOPS>
    23. <DBInstanceType>Primary</DBInstanceType>
    24. <DBInstanceStatus>Running</DBInstanceStatus>
    25. <MasterInstanceId></MasterInstanceId>
    26. <EngineVersion>5.5</EngineVersion>
    27. <IncrementSourceDBInstanceId></IncrementSourceDBInstanceId>
    28. <GuardDBInstanceId></GuardDBInstanceId>
    29. <DBInstanceStorage>10</DBInstanceStorage>
    30. <DBInstanceDescription></DBInstanceDescription>
    31. <DBInstanceId>rdsfnjfqu7vjnuj</DBInstanceId>
    32. <PayType>Postpaid</PayType>
    33. <ExpireTime></ExpireTime>
    34. <MaintainTime></MaintainTime>
    35. <DBInstanceClass>rds.mys2.small</DBInstanceClass>
    36. <SecurityIPList>11.11.11.11</SecurityIPList>
    37. <Port>3306</Port>
    38. </DBInstanceAttribute>
    39. </CreateDBInstanceResponse>

    JSON format:

    1. {
    2. "Items": {
    3. "DBInstanceAttribute": [
    4. {
    5. "LockMode": "Unlock",
    6. "ConnectionString": "rdsfnjfqu7vjnuj.mysql.rds.aliyuncs.com",
    7. "CreationTime": "2014-10-10T10:28:48Z",
    8. "DBInstanceNetType": "Internet",
    9. "ReadOnlyDBInstanceIds": {
    10. "ReadOnlyDBInstanceId": []
    11. },
    12. "MaxConnections": 60,
    13. "LockReason": "",
    14. "Engine": "MySQL",
    15. "AvailabilityValue": "100.0%",
    16. "AccountMaxQuantity": 50,
    17. "DBMaxQuantity": 200,
    18. "RegionId": "cn-hangzhou",
    19. "TempDBInstanceId": "",
    20. "DBInstanceMemory": 240,
    21. "MaxIOPS": 150,
    22. "DBInstanceType": "Primary",
    23. "DBInstanceStatus": "Running",
    24. "MasterInstanceId": "",
    25. "EngineVersion": "5.5",
    26. "IncrementSourceDBInstanceId": "",
    27. "GuardDBInstanceId": "",
    28. "DBInstanceStorage": 10,
    29. "DBInstanceDescription": "",
    30. "DBInstanceId": "rdsfnjfqu7vjnuj",
    31. "PayType": "Postpaid",
    32. "ExpireTime": "",
    33. "MaintainTime": "",
    34. "DBInstanceClass": "rds.mys2.small",
    35. "SecurityIPList": "11.11.11.11",
    36. "Port": "3306"
    37. }
    38. ]
    39. },
    40. "RequestId": "27BB49FA-DA47-4162-B39D-FC001E35C1C1"
    41. }
Thank you! We've received your feedback.