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

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Managing instancesDescribeDBInstanceEndpoints
Copy page
Download PDF
Managing instances
DescribeDBInstanceEndpoints
Copy page
Download PDF
DescribeDBInstanceEndpoints

Call the DescribeDBInstanceEndpoints API to query the list of connection addresses of the instance.

Request type

Synchronous request.

Request parameters

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

Response parameters

Name
Type
Example
Description
Endpoints
Object[]
Please refer to the return example.
Connection information of the instance
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.
EipLocked
Boolean
false

Whether the EIP used to connect to the terminal has been shut down due to arrears. Values:

  • true: Yes.
  • false: No.
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.

Sample request 

POST /?Action=DescribeDBInstanceEndpoints&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-f83edc2e****"
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.12.04 11:25:47