All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstanceAttribute

Last Updated:Feb 29, 2024

Queries the details of an instance.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeDBInstanceAttributeREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

Notice 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*****
ExpiredstringNo

Specifies whether the instance expires. Valid values:

  • True: The instance expires.
  • False: The instance does not expire.
False

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Itemsobject []

The details of the instance.

VpcIdstring

The virtual private cloud (VPC) ID.

vpc-*****
CreationTimestring

The creation time of the instance. 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
IncrementSourceDBInstanceIdstring

The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance comes from its primary instance. The incremental data of a read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.

rm-uf6wjk5*****
MaintainTimestring

The maintenance window of the instance. The time is displayed in UTC. The maintenance window displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.

00:00Z-02:00Z
PayTypestring

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Postpaid
AvailabilityValuestring

The availability status of the instance in percentage.

100.0%
EngineVersionstring

The database engine version.

5.5
DedicatedHostGroupIdstring

The ID of the dedicated cluster to which the instances belong.

dhg-7a9*****
ConnectionStringstring

The internal endpoint.

rm-uf6wjk5*****.mysql.rds.aliyuncs.com
SuperPermissionModestring

Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, Active Directory (AD) account, and host account. Valid values:

  • Enable
  • Disabled
Disabled
InstanceNetworkTypestring

The network type of the instance. Valid values:

  • Classic
  • VPC
Classic
MasterInstanceIdstring

The primary instance ID.

Note If this parameter is not returned, the instance is the primary instance.
rm-uf6wjk5*****
AutoUpgradeMinorVersionstring

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
ExpireTimestring

The expiration time of the instance. 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.
2019-03-27T16:00:00Z
AccountMaxQuantityinteger

The maximum number of accounts that can be created on the instance.

50
MasterZonestring

The zone ID of the primary instance.

5454284
GuardDBInstanceIdstring

The ID of the disaster recovery instance that is attached to the primary instance.

rm-uf64zsu*****
DBInstanceStorageinteger

The storage capacity of the instance. Unit: GB.

10
TimeZonestring

The time zone.

Central Standard Time
LatestKernelVersionstring

The latest minor engine version that is supported by the instance.

rds_20201031
TipsLevelinteger

The severity 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 instance performance may be affected. You must adjust the specifications of these instances based on your business requirements.
1
ZoneIdstring

The zone ID.

cn-hangzhou-a
MaxConnectionsinteger

The maximum number of concurrent connections.

60
DBInstanceIdstring

The instance ID.

rm-uf6wjk5*****
TempDBInstanceIdstring

The ID of the temporary instance that is attached to the primary instance.

rm-uf64zsu*****
AdvancedFeaturesstring

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
DBInstanceStorageTypestring

The storage type of the instance. Valid values:

  • local_ssd or ephemeral_ssd: local SSD
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced SSD (ESSD).
  • general_essd: general ESSD
local_ssd
DBInstanceMemorylong

The memory capacity of the instance. Unit: MB.

4096
IPTypestring

The IP address type. Only IPv4 addresses are supported.

IPv4
ConsoleVersionstring

The type of the proxy that is used by the instance. Valid values:

  • 1: shared database proxy
  • 2: dedicated database proxy
Note We recommend that you use the ProxyType parameter instead of this parameter.
2
ConnectionModestring

The connection mode of the instance. Valid values:

  • Standard: standard mode
  • Safe: database proxy mode
Standard
Portstring

The port that is used to connect to the instance over an internal network.

3306
LockModestring

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 space.
  • LockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically locked due to exhausted storage.
Unlock
GeneralGroupNamestring

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
VpcCloudInstanceIdstring

The ID of the instance. This parameter is returned only when the instance resides in a VPC.

vpc-23rsxdf*****
Collationstring

The character set collation of the instance.

Chinese_PRC_CI_AS
MaxIOPSinteger

The maximum number of I/O requests per second.

150
MaxIOMBPSinteger

The maximum I/O throughput. Unit: MB/s.

0MB/s
Tipsstring

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.
SecurityIPListstring

The IP addresses in the IP address whitelist.

192.168.XX.XX/24
SecurityIPModestring

The whitelist mode. Valid values:

  • normal: standard whitelist mode
  • safety: enhanced whitelist mode
normal
DBInstanceClassTypestring

The instance family. Valid values:

  • s: shared instance family
  • x: general-purpose instance family
  • d: dedicated instance family
  • h: dedicated host instance family
s
DBInstanceDiskUsedstring

The disk usage of the instance. Unit: MB.

300
ProxyTypeinteger

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
CurrentKernelVersionstring

The minor engine version.

rds_20181010
DBInstanceDescriptionstring

The instance description.

The number of cores that are configured for the instance.
DBInstanceCPUstring

The number of CPU cores.

2
DBInstanceNetTypestring

The type of the network over which the instance is connected. Valid values:

  • Internet
  • Intranet
Internet
DBInstanceTypestring

The instance type. Valid values:

  • Primary: primary instance
  • Readonly: read-only instance
  • Guard: disaster recovery instance
  • Temp: temporary instance
Primary
LockReasonstring

The reason why the instance was locked.

instance_expired
DBInstanceStatusstring

The status of the instance. For more information, see Instance states.

Running
DBMaxQuantityinteger

The maximum number of databases that can be created on the instance.

200
RegionIdstring

The region ID.

cn-hangzhou
ReadonlyInstanceSQLDelayedTimestring

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
VSwitchIdstring

The vSwitch ID.

vsw-*****
ResourceGroupIdstring

The resource group ID.

rg-acfmy*****
Categorystring

The RDS edition. Valid values:

  • Basic: RDS Basic Edition
  • HighAvailability: RDS High-availability Edition
  • cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL
  • AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server
  • Finance: RDS Enterprise Edition
  • Serverless_basic: RDS Basic Edition for serverless instances
Basic
DBInstanceClassstring

The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types.

rds.mys2.small
Enginestring

The database engine of the instance. Valid values:

  • MySQL
  • PostgreSQL
  • SQLServer
  • MariaDB
MySQL
SlaveZonesobject []

The zone IDs of the secondary instances.

ZoneIdstring

The zone ID.

cn-hangzhou-a
ReadOnlyDBInstanceIdsobject []

The IDs of the read-only instances that are attached to the primary instance.

DBInstanceIdstring

The read-only instance ID.

rm-bp*****
Extraobject

The extended information.

DBInstanceIdsarray

The instance IDs.

string

The instance ID.

rm-uf6wjk5*****
DeletionProtectionboolean

Indicates whether the release protection feature is enabled. Valid values:

  • true
  • false
true
ServerlessConfigobject

The settings of the serverless instance.

ScaleMindouble

The minimum number of RDS Capacity Units (RCUs).

0.5
ScaleMaxdouble

The maximum number of RCUs.

8
AutoPauseboolean

Indicates whether the automatic start and stop feature is enabled for the serverless instance. Valid values:

  • true
  • false (default)
Note After the automatic start and stop 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
SwitchForceboolean

Indicates whether the forced scaling feature is enabled for the serverless instance. Valid values:

  • true
  • false (default)
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
BabelfishConfigobject

The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.

Note This parameter applies only to ApsaraDB RDS for PostgreSQL instances for which Babelfish is enabled. For more information, see Introduction to Babelfish.
BabelfishEnabledstring

Indicates whether Babelfish is enabled.

Note If Babelfish is enabled when you purchase an ApsaraDB RDS for PostgreSQL instance, this parameter is fixed as true.
true
MigrationModestring

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
kindCodestring

An internal parameter. You do not need to specify this parameter.

The architecture type of the instance. Valid values: - **x86** - **arm**
InstructionSetArchstring

The architecture type of the instance. Valid values:

  • x86
  • arm
x86
DBClusterNodesobject []

The information about the node in the cluster.

NodeRegionIdstring

The region ID.

cn-beijing
NodeZoneIdstring

The zone ID.

cn-beijing-h
NodeIdstring

The node ID.

rn-****
NodeRolestring

The role of the node. Valid values:

  • primary
  • secondary
primary
ClassCodestring

The node specification.

mysql.n2.medium.xc
ClassTypestring

The node type. Valid values:

  • d: dedicated node type
  • x: general-purpose node type
x
Cpustring

The number of CPU cores of the node.

4
Memorystring

The memory capacity of the node. Unit: MB.

4096
Statusstring

The node status. Valid values:

  • active
  • creating
  • deleting
  • classchanging
  • restarting
active
IoAccelerationEnabledstring

A reserved parameter.

None
PGBouncerEnabledstring

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
ColdDataEnabledboolean

A reserved parameter.

None

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",
        "DBInstanceDiskUsed": "300",
        "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",
              "ClassType": "x",
              "Cpu": "4",
              "Memory": "4096",
              "Status": "active"
            }
          ]
        },
        "BurstingEnabled": false,
        "BpeEnabled": "false",
        "IoAccelerationEnabled": "None",
        "PGBouncerEnabled": "true",
        "ColdDataEnabled": true
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ConnectTimeoutRetryLaterConnect timeout retry later.The connection timed out. Please try again later.
400TimeoutRetryLaterTimeout, please retry later.-
400DataNotExistData not exist.No data is available.

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

Change history

Change timeSummary of changesOperation
2024-01-04The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-11-15The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-10-11The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-06-27The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-09-01The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-07-05API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-02-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-02-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-02-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-02-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-02-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.