You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

Copy page
Download PDF
Managing instances
DescribeDBInstanceDetail
Copy page
Download PDF
DescribeDBInstanceDetail

Call the DescribeDBInstanceDetail API to view instance details.

Request type

Synchronous request.

Precautions

This interface has been deprecated. Please use the following APIs to query the information of the instance:

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
mysql-cf0c1a52****
Instance ID.

Response parameters

Name
Type
Example
Description
BasicInfo
Object
See response example.
Basic instance information.
AllowListVersion
String
V2
White list version.
BackupFreeQuotaSize
Long
20
Free backup file storage space for instances. Unit: GB.
BasicBackupBinlogSize
Long
173787198
Local data backup size. Unit Byte.
BasicBackupDataSize
Long
173284635
Local log backup size. The unit is Byte.
BackupUse
Double
0.1
The instance has used backup space. Unit: GB.
CreateTime
String
2022-01-01T10:10:10Z
The local time when the instance is created.
DBEngineVersion
String
MySQL_8_0

Compatible versions. Values:

  • MySQL_5_7: MySQL version 5.7.
  • MySQL_8_0: MySQL version 8.0.
DataSyncMode
String
Async

Data synchronization methods:

  • SemiSync: Semi-synchronous.
  • Async: Asynchronous.
InstanceId
String
mysql-66347599****
Instance ID.
InstanceName
String
Test Instance
Instance name.
InstanceStatus
String
Running

Instance status, values:

  • Creating: In the process of creation.
  • Running: In operation.
  • Deleting: In the process of deletion.
  • Restarting: In the process of restart.
  • Updating: In the process of change.
  • Restoring: In the process of restoration.
  • Error: Error.
  • Upgrading: In the process of upgrade.
  • Released: In the process of recycling.
  • Recycled: Recycled.
  • MasterChanging: In the process of master node switching.
  • TDEUpdating: In the process of TDE modification.
  • Closed: Shut down.
  • Maintaining: In maintenance.
  • CreateFailed: Creation failed.
  • Closing: In the process of shutting down.
  • SSLUpdating: In the process of SSL change.
  • AllowListMaintaining: In the process of white list change.
  • Unknown: Unknown.
  • ProxyCreating: In the process of proxy opening.
  • ProxyDeleting: In the process of proxy closing.
  • ChargeTypeChanging: In the process of billing type change.
  • NetWorkChanging: In the process of network change.
InstanceType
String
DoubleNode

Instance type. Values:

  • DoubleNode, double node type.
  • MultiNode, multi-node type.
LowerCaseTableNames
String
true

Whether the table name is case-sensitive, the default value is true. Values:

  • false: The table name is stored as fixed and the table name is case-sensitive.
  • true: The table name will be stored in lowercase and the table name is case-insensitive.
MaintenanceWindow
Object
See example.
Specify the maintenance window for the instance during creation. This field is optional. If not set, it defaults to UTC 18:00Z-21:59Z (i.e., Beijing time 02:00-05:59) every day of the week.
MaintenanceTime
String
22:00Z-02:00Z
The maintainable time period of the instance. Format: HH:mmZ-HH:mmZ (UTC time).
DayKind
String
Week
The maintainable cycle granularity, with a value of Week, week.
DayOfWeek
String[]
["Monday","Tuesday"]
Specify which days of the week to modify the maintainable time period. The values are: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, and multiple options are available. If this value is not specified or is empty, it is defaulted that all seven days of the week are specified.
RegionId
String
cn-beijing
Region ID, which can be queried by calling DescribeRegions. Use this parameter to specify the region where the instance is to be created.
ZoneId
String
cn-beijing-a
Availability zone ID.
VCPU
Integer
1
CPU size. For example: 1 indicates 1U.
Memory
Integer
2
Memory size. Unit: GB.
NodeSpec
String
rds.mysql.1c2g
Node Specifications. For details about the node specifications, see Product Specifications.
NodeNumber
String
2
The number of nodes.
UpdateTime
String
2022-01-01T10:10:10Z
Update the local time of the instance.
StorageType
String
LocalSSD
Instance storage type. The value is LocalSSD, that is, local SSD disk.
StorageSpace
Long
200
Total storage space of the instance. Unit: GB.
StorageUse
Double
4.14
The storage space used by the instance. Unit: GB.
VpcId
String
vpc-3rebt5uf5fr405zsk2if9****
The ID of the virtual private cloud (VPC).
SubnetId
String
subnet-3rf442t6a54w016nf3pg9****
Subnet ID.
TimeZone
String
UTC + 08:00
Time zone
ProjectName
String
Test
The affiliated project.
Tags
Object[]
Please refer to the example.

The bound tag key and tag value array object.

tip

When used as a return parameter, it is only returned when the instance has bound tags.

Key
String
tagkey

The tag key of the instance tag. The setting rules for the tag key are as follows:

  • Supports any language letters or characters (such as Chinese, English letters, etc.), numbers, and spaces.
  • Supports special characters: _.:/=+-@.
  • volc: is a reserved tag key for the system. When adding a tag, the beginning of the tag key cannot be set to any case form of volc:.
  • The length of the tag key needs to be 1 to 128 characters.
Value
String
tagvalue

The tag value of the instance tag. The setting rules of the tag value are as follows:

  • Any language letters or characters (such as Chinese, English letters, etc.), numbers, and spaces are supported.
  • Special characters are supported: _.:/=+-@.
  • The length of the tag value needs to be 0 to 256 characters, that is, the tag value can be empty.
CurrentKernelVersion
String
MySQL 8.0.32_20240415
The minor version of the instance kernel.
DrDtsTaskId
String
df5a93434880466cb8422b2db93d****
The ID of the data synchronization link between the primary instance and the disaster recovery instance in the DTS data synchronization task.
MasterRegion
String
cn-shanghai
The region where the primary instance of the disaster recovery instance is located.
DrDtsTaskName
String
Disaster Recovery Instance Test Link
The name of the data synchronization link between the primary instance and the disaster recovery instance in the DTS data synchronization task.
DrDtsTaskStatus
String
Running
The status of the data synchronization link between the primary instance and the disaster recovery instance in the DTS data synchronization task.
MasterInstanceId
String
mysql-ce48081d****
The ID of the primary instance of the disaster recovery instance.
DeletionProtection
String
Enabled

Whether to enable the deletion protection function of the instance. Value:

  • Enabled: Yes.
  • Disabled: No. Default value.
MasterInstanceName
String
Disaster recovery instance and primary instance.
The name of the primary instance of the disaster recovery instance.
DrSecondsBehindMaster
Integer
1
The data synchronization delay between the disaster recovery instance and the primary instance.
AutoUpgradeMinorVersion
String
Auto

The upgrade strategy for the minor version of the instance kernel. Values:

  • Auto: Automatic upgrade.
  • Manual: Manual upgrade.
ChargeDetail
Object
See response example.
Billing method.
ChargeType
String
PostPaid

Payment type. Values:

  • PostPaid: Pay-as-you-go (post-payment).
  • PrePaid: Annual and monthly subscription (pre-payment).
AutoRenew
Boolean
true

Whether to automatically renew in the prepaid scenario.

  • true: Automatically renew upon expiration.
  • false: Do not automatically renew upon expiration.
PeriodUnit
String
Month

The purchase cycle in the prepaid scenario.

  • Month: The purchase cycle is monthly.
  • Year: The purchase cycle is yearly.

tip

When this parameter is used as a request parameter, the default value is Month.

Period
Integer
1

The purchase duration in the prepaid scenario.

tip

  • When this parameter is used as a request parameter, the default value is 1.
  • When the value of PeriodUnit is Year, the value range of Period is 1~3.
  • When the value of PeriodUnit is Month, the value range of Period is 1~9.
ChargeStatus
String
Normal

Billing status of the instance. Values:

  • Normal: Normal.
  • Overdue: Arrears.
  • Unpaid: Waiting for payment.
ChargeStartTime
String
2025-07-22T13:10:15.000Z
The billing start time of the instance (UTC time). The format is yyyy-MM-ddTHH:mm:ss.sssZ.
ChargeEndTime
String
2025-08-22T15:59:59.000Z

The billing end time (UTC time) of the yearly and monthly subscribed instances. The format is yyyy-MM-ddTHH:mm:ss.sssZ.

tip

If the queried instance is a pay-as-you-go instance, this field will be returned as empty.

OverdueTime
String
2025-08-23T04:00:00.000Z
The time (UTC time) when the instance is shut down due to arrears (pay-as-you-go) or expiration (yearly/monthly subscription). The format is yyyy-MM-ddTHH:mm:ss.sssZ.
OverdueReclaimTime
String
2025-08-29T15:59:59.000Z
The expected release time (UTC time) after the instance is shut down due to arrears (pay-as-you-go) or expiration (yearly or monthly subscription). The format is yyyy-MM-ddTHH:mm:ss.sssZ.
TempModifyStartTime
String
2022-01-01T10:10:10.000Z

The start time of the temporary upgrade (UTC time). The format is yyyy-MM-ddTHH:mm:ss.sssZ.

tip

For instances that are not in the temporary upgrade period, this field will not be returned.

TempModifyEndTime
String
2022-01-01T10:10:09.000Z

The restoration time (UTC time) of the temporary upgrade. The format is yyyy-MM-ddTHH:mm:ss.sssZ.

tip

For instances not in the temporary upgrade period, this field is not returned.

Endpoints
Object[]
See response example.
Instance connection information.
Addresses
Object[]
Please refer to the return example.
Address list.
DNSVisibility
Boolean
false
  • false: Private network resolution of Volcano Engine (default).
  • true: Private network and public network resolution of Volcano Engine.
Domain
String
mysql1d797b6f****.rds.ivolces.com
Connect to the domain name.
EipId
String
eip-13g6t81tglmgw3n6nu4vt****
The ID of the EIP, which is only valid for the Public address.
IPAddress
String
10.***.***.3
IP address.
InternetProtocol
String
IPv4
IP protocol version. The value is IPv4.
NetworkType
String
Private

Network address type, with the following values:

  • Private: Private network address.
  • Public: Public network address.
Port
String
3306
Port.
SubnetId
String
subnet-2bzr8zdx5o8ao2dx0efq4****
Subnet ID, only valid for Private addresses.
AutoAddNewNodes
String
Enable

When the terminal type is a read-write terminal or a read-only terminal, it supports setting whether a new node is automatically joined. Value:

  • Enable: Automatically joined
  • Disable: Not automatically joined (default).
ConnectionInfoTags
String[]
["Default"]
Connect the terminal tabs.
ConnectionMode
String
Proxy

Connection terminal type. Values:

  • Proxy: Proxy terminal.
  • Direct: Direct terminal.

tip

  • If the database proxy function of the instance is enabled, the value can be Proxy or Direct.
  • If the database proxy function of the instance is not enabled, the value can only be Direct.

You can call the DescribeDBInstanceDetail interface to query the opening status of the database proxy function of the instance.

ConnectionPoolType
String
Direct

The connection pool type of the proxy terminal. Values:

  • Transaction: Transaction-level connection pool. Default value.
  • Direct: Direct connection mode.
Description
String
This is a description of connecting to the terminal.
The description information of connecting to the terminal.
EnableReadOnly
String
Enable

Whether global read-only is enabled, value:

  • Enable: Enabled.
  • Disable: Not enabled.
EnableReadWriteSplitting
String
Enable

Whether read-write separation has been enabled, with possible values:

  • Enable: Enabled.
  • Disable: Not enabled.
EndpointId
String
mysql-050b3e08****
Instance connection terminal ID.
EndpointName
String
Custom connection terminal
Instance connection terminal name.
EndpointType
String
Custom
Terminal type. The value is Custom, a custom terminal.
IdleConnectionReclaim
Boolean
true

Whether the idle connection recycling function is enabled.

  • true: Enabled.
  • false: Not enabled.

tip

This field will only be returned by the proxy terminal.

ImplicitTransSplit
Boolean
false

Whether to enable transaction separation. Value:

  • true: Yes.
  • false: No.

tip

Only the proxy terminal will return this field.

MasterNodeRouting
Boolean
false

Whether to enable the master node route. Value:

  • true: Yes.
  • false: No.

tip

This field will only be returned by the proxy terminal.

MasterProtectorTimeout
Integer
60

Overload protection timeout. The value range is an integer between 60 and 7200, and the unit is seconds.

tip

Only the proxy terminal will return this field.

MultiStatementsMode
String
Loose

The Multi-Statements mode of the proxy terminal. Values:

  • Strict: Strict mode. Default value.
  • Loose: Loose mode.
OverloadProtection
Boolean
false

Whether to turn on overload protection. Values:

  • true: Yes.
  • false: No.

tip

This field will only be returned by the proxy terminal.

ReadOnlyNodeDistributionType
String
LoadSchedule

Read the weight distribution mode. This parameter needs to be passed in when the read-write separation setting is set to true. When used as a request parameter in the CreateDBEndpoint and ModifyDBEndpoint interfaces, the value range is as follows:

  • LoadSchedule: Load scheduling.
  • RoundRobinCustom: Round-robin scheduling with custom weights.
  • RoundRobinAuto: Round-robin scheduling with automatically assigned weights.

When used as a return parameter in the DescribeDBInstanceDetail interface, the value range is as follows:

  • Default: Automatically assign weights according to the specification.
  • Custom: Customize the weight distribution.
  • RoundRobin: Round-robin scheduling.
  • LoadSchedule: Load scheduling.
  • RoundRobinCustom: Round-robin scheduling with custom weights.
  • RoundRobinAuto: Round-robin scheduling with automatically assigned weights.
ReadOnlyNodeMaxDelayTime
Integer
40
The read-only node delay threshold. The value range is from 1 to 3600, and the default value is 30, with the unit being seconds.
ReadOnlyNodeWeight
Object[]
Please refer to the return example.
The list of nodes configured in the connection terminal and the corresponding read-only weights.
NodeId
String
mysql-050b3e08****-2
The read-only node needs to pass in the NodeId, while the master node does not need to pass in.
NodeType
String
Primary

Node types.

  • Primary: Primary node.
  • ReadOnly: Read-only node.
Weight
Integer
100

The read weight of the node, increasing by 100, with a maximum value of 10000.

tip

The weights cannot all be set to 0.

ReadWriteMode
String
ReadOnly

Read/Write Modes:

  • ReadWrite: Read and write.
  • ReadOnly: Read only.
EnableConnectionPersistent
Boolean
false

Whether to enable connection persistence. Values:

  • true: Yes.
  • false: No.
Nodes
Object[]
See response example.
Instance node information.
CreateTime
String
2024-10-29T08:45:28.000Z
The creation time of the node (UTC time). The format is yyyy-MM-ddTHH:mm:ss.sssZ.
DelayReplicationTime
Long
1000
The delay replication time of the read-only node, with a value ranging from 0 to 604800, and the unit is seconds.
InstanceId
String
mysql-h441603c****
Instance ID.
Memory
Integer
2
Memory size, in units of GB.
NodeId
String
mysql-h441603c****-01
Node ID.
NodeSpec
String
rds.mysql.d1.n.2c4g
Node Specifications. For details about node specifications, see Product Specifications.
NodeStatus
String
Running

Node status, with possible values:

  • Running: In operation.
  • Creating: In the process of being created.
  • Deleting: In the process of being deleted.
  • Restarting: In the process of restarting.
  • Restoring: In the process of restoration.
  • Updating: In the process of being updated.
  • Upgrading: In the process of being upgraded.
  • Error: Error.
NodeType
String
Primary

Node type. Values:

  • Primary: Primary node.
  • Secondary: Secondary node.
  • ReadOnly: Read-only node.
RegionId
String
cn-beijing
Region ID. You can call DescribeRegions to query and use this parameter to specify the region where the instance is to be created.
SyncDelay
Long
28
The delay time between the node and the master node. The unit is milliseconds (ms).
UpdateTime
String
2024-10-31T08:45:28.000Z
The node updates the local time.
VCPU
Integer
1
The number of CPU cores of the node.
ZoneId
String
cn-beijing-a
Availability zone ID.
ProxyDetail
Object
See response example.
Configuration information for the instance database proxy service.
DBProxyStatus
String
Shutdown

The status of the database proxy function of the instance. Values:

  • Creating: The proxy is being started.

  • Running: The proxy is running.

  • Shutdown: The proxy has been shut down.

  • Deleting: The proxy is being shut down.

ProxyResourceInfo
Object
Please refer to the return example.
The resource information of the database proxy service of the instance.
MaxProxyCpuNum
Integer
1024
The maximum number of cores that the user can configure for the database proxy service.
MinProxyCpuNum
Integer
2
The minimum number of cores that a user can configure for the database proxy service.
CurrentProxyCpuNum
Integer
2
The number of cores of the current instance database proxy service.
DisasterRecoveryInstances
Object[]
See response example.

Information about the disaster recovery instance in the disaster recovery instance.

tip

This field is returned for the primary instance.

Region
String
cn-shanghai
The region where the disaster recovery instance is located.
DtsTaskId
String
9c0c17a0b82f460b87b338d1db8d****
The ID of the synchronization task between the primary instance and the disaster recovery instance.
InstanceId
String
mysql-6c7c35fb****
The ID of the disaster recovery instance.
DtsTaskName
String
TestTask
The name of the synchronization task between the primary instance and the disaster recovery instance.
InstanceName
String
DrInstance-test
The name of the disaster recovery instance.
DtsTaskStatus
String
Running
The status of the synchronization task between the primary instance and the disaster recovery instance.
SecondsBehindMaster
Integer
0
The latency between the disaster recovery instance and the primary instance.

Sample request

POST /?Action=DescribeDBInstanceDetail&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-66347599****"
}

Sample response

{
    "ResponseMetadata": {
        "RequestId": "2024111814372900D9621B68C57432A544-ba24ec",
        "Action": "DescribeDBInstanceDetail",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BasicInfo": {
            "AllowListVersion": "v2",
            "BackupAuditLogSize": 0,
            "BackupBinLogSize": 397089974,
            "BackupChargeStatus": "Normal",
            "BackupDataSize": 99443762,
            "BackupErrorLogSize": 63567,
            "BackupFreeQuotaSize": 20,
            "BackupLogSize": 397321976,
            "BackupSlowLogSize": 168435,
            "BackupUse": 0.42,
            "BasicBackupBinlogSize": 390123374,
            "BasicBackupDataSize": 49721881,
            "CreateTime": "2024-10-29T08:45:27.000Z",
            "CurrentKernelVersion": "MySQL 5.7.32_20240615",
            "DBEngine": "Mysql",
            "DBEngineVersion": "MySQL_5_7",
            "DataSyncMode": "SemiSync",
            "InnerVersion": "",
            "InstanceId": "mysql-66347599****",
            "InstanceName": "测试实例",
            "InstanceStatus": "Running",
            "InstanceType": "DoubleNode",
            "IsLatestVersion": false,
            "LowerCaseTableNames": "1",
            "MaintenanceWindow": {
                "DayKind": "Week",
                "DayOfWeek": [
                    "Monday"
                ],
                "MaintenanceTime": "18:00Z-21:59Z"
            },
            "Memory": 1,
            "NodeNumber": "2",
            "NodeSpec": "rds.mysql.d1.n.1c1g",
            "PrimaryDBAccount": "",
            "ProjectName": "default",
            "RegionId": "cn-beijing",
            "ServerCollation": "",
            "ServiceArea": null,
            "ShardNumber": 0,
            "StorageAuditLogSize": 4096,
            "StorageBinLogSize": 29985723,
            "StorageDataSize": 4415339996,
            "StorageErrorLogSize": 53675,
            "StorageLogSize": 30131720,
            "StorageSlowLogSize": 88226,
            "StorageSpace": 20,
            "StorageType": "LocalSSD",
            "StorageUse": 4.3,
            "SubnetId": "subnet-rrot9xdj3j0gv0x57gv****",
            "TimeZone": "UTC +08:00",
            "UpdateTime": "",
            "VCPU": 1,
            "VpcId": "vpc-rrot7em3x05cv0x58dx****",
            "ZoneId": "cn-beijing-a"
        },
        "ChargeDetail": {
            "AutoRenew": false,
            "ChargeEndTime": "",
            "ChargeStartTime": "2024-10-29T08:45:31.000Z",
            "ChargeStatus": "Normal",
            "ChargeType": "PostPaid",
            "Number": 1,
            "OverdueReclaimTime": "2200-01-15T16:00:00.000Z",
            "OverdueTime": "",
            "Period": 1,
            "PeriodUnit": "Month"
        },
        "Endpoints": [
            {
                "Address": [
                    {
                        "DNSVisibility": false,
                        "Domain": "mysql66347599****.rds.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.6",
                        "IPv6Address": "",
                        "InternetProtocol": "IPv4",
                        "NetworkType": "Private",
                        "Port": "3306",
                        "SubnetId": "subnet-rrot9xdj3j0gv0x57gv****"
                    }
                ],
                "Addresses": [
                    {
                        "DNSVisibility": false,
                        "Domain": "mysql66347599****.rds.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.6",
                        "IPv6Address": "",
                        "InternetProtocol": "IPv4",
                        "NetworkType": "Private",
                        "Port": "3306",
                        "SubnetId": "subnet-rrot9xdj3j0gv0x57gv****"
                    }
                ],
                "AutoAddNewNodes": "Enable",
                "ConnectionMode": "Proxy",
                "ConnectionPoolType": "Transaction",
                "Description": "",
                "EnableReadOnly": "Disable",
                "EnableReadWriteSplitting": "Disable",
                "EndpointId": "mysql-66347599****-cluster",
                "EndpointName": "",
                "EndpointProxyPort": "3679",
                "EndpointType": "Cluster",
                "IdleConnectionReclaim": false,
                "ReadOnlyNodeDistributionType": "Default",
                "ReadOnlyNodeMaxDelayTime": 30,
                "ReadOnlyNodeWeight": [
                    {
                        "NodeId": "",
                        "NodeType": "Primary",
                        "Weight": 100
                    }
                ],
                "ReadWriteMode": "ReadWrite"
            }
        ],
        "Nodes": [
            {
                "CreateTime": "2024-10-29T08:45:28.000Z",
                "DelayReplicationTime": 0,
                "InstanceId": "mysql-66347599****",
                "Memory": 1,
                "NodeId": "mysql-66347599****-m64c5-0",
                "NodeSpec": "rds.mysql.d1.n.1c1g",
                "NodeStatus": "Running",
                "NodeType": "Primary",
                "RegionId": "cn-beijing",
                "ShardId": "",
                "SubInstanceId": "mysql-66347599****-m64c5",
                "SyncDelay": 0,
                "UpdateTime": "",
                "VCPU": 1,
                "ZoneId": "cn-beijing-a"
            },
            {
                "CreateTime": "2024-10-29T08:45:29.000Z",
                "DelayReplicationTime": 0,
                "InstanceId": "mysql-66347599****",
                "Memory": 1,
                "NodeId": "mysql-66347599****-s7fc0-0",
                "NodeSpec": "rds.mysql.d1.n.1c1g",
                "NodeStatus": "Running",
                "NodeType": "Secondary",
                "RegionId": "cn-beijing",
                "ShardId": "",
                "SubInstanceId": "mysql-66347599****-s7fc0",
                "SyncDelay": 137,
                "UpdateTime": "",
                "VCPU": 1,
                "ZoneId": "cn-beijing-a"
            }
        ],
        "ProxyDetail": {
            "Charged": true,
            "DBProxyStatus": "Running",
            "ProxyResourceInfo": {
                "CurrentProxyCpuNum": 2,
                "MaxProxyCpuNum": 1024,
                "MinProxyCpuNum": 2
            }
        }
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.08.15 18:32:42