云数据库 veDB MySQL 版
云数据库 veDB MySQL 版
云数据库 veDB MySQL 版
文档指南
请输入
产品动态
用户指南
实例管理
备份与恢复
参数配置
任务中心
最佳实践
API 参考
v2（2024-01-01）
v1（2022-01-01）
实例管理
连接管理
数据库管理
账号管理
安全
备份恢复
参数管理
开发者工具
附录
相关协议
- 文档首页
云数据库 veDB MySQL 版API 参考v1（2022-01-01）连接管理DescribeDBEndpoint - 列举连接终端
复制全文
下载 pdfDescribeDBEndpoint - 列举连接终端
文档反馈
问问助手调用 DescribeDBEndpoint 接口查询实例连接终端的详细信息。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 是 | vedbm-2pf2xk5v**** | 实例 ID。 |
EndpointId | String | 否 | vedbm-2pf2xk5v****-Custom-50yv | 连接终端 ID。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Integer | 2 | 连接终端总数。 |
Endpoints | 连接终端的详细信息。 |
EndpointObject
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Addresses | 请参见返回示例。 | 地址信息。 | |
AutoAddNewNodes | Boolean | true | 是否允许自动加入新节点，取值：
|
Description | String | 主地址 | 地址描述。 |
EndpointId | String | vedbm-h441603c68aaa**** | 实例连接终端 ID。 |
EndpointName | String | 默认终端 | 实例连接终端名称。 |
EndpointType | String | Cluster | 连接终端类型，取值：
|
MasterAcceptReadRequests | Boolean | true | 主节点是否接受读请求。仅对读写模式的连接终端有效。
|
NodeIds | Array of String | ["vedbm-r3sar8zi****-0", "vedbm-r3sar8zi****-1"] | 连接终端配置的节点列表。 |
ReadWriteMode | String | ReadWrite | 连接终端的读写模式，取值：
|
DistributedTransaction | Boolean | true | 是否开启事务拆分，仅对读写模式的连接终端有效。取值：
|
ConsistLevel | String | Session | 一致性级别，仅对读写模式的连接终端有效。取值：
|
ConsistTimeout | Integer | 10000 | 延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us。 说明 当 ConsistLevel 取值为 Global 或 Session 时，该参数才生效。 |
ConsistTimeoutAction | String | ReadMaster | 只读节点同步数据超时后的超时策略，支持以下两种策略：
说明 当 ConsistLevel 取值为 Global 或 Session 时，该参数才生效。 |
ConnectionPool | String | Off |
AddressObject
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
DNSVisibility | Boolean | false | 解析方式。当前返回值只能为 false（火山引擎私网解析）。 |
Domain | String | vedbm-fkfb7ag0****.master.mysql.vedb.ivolces.com | 实例内网访问域名。 |
IPAddress | String | 100...*** | IP 地址。 |
NetworkType | String | Private | 网络类型：
|
Port | String | 3306 | 实例内网访问端口。 |
SubnetId | String | subnet-3tfam28a**** | 子网 ID。子网必须属于所选的可用区。 |
EipId | String | eip-13g56dc5u2uio3n6nu4kb**** | 公网 ID。 |
示例
请求示例
POST /?Action=DescribeDBEndpoint&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host:vedbm.cn-beijing.volcengineapi.com
X-Date: 20220101T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
"InstanceId": "vedbm-53vb4ido****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230828164117A453591E8C1EBE492369",
"Action": "DescribeDBEndpoint",
"Version": "2022-01-01",
"Service": "vedbm",
"Region": "cn-beijing"
},
"Result": {
"Endpoints": [
{
"Addresses": [
{
"DNSVisibility": false,
"Domain": "vedbm-53vb4ido****.pri.mysql.vedb.ivolces.com",
"EipId": "",
"IPAddress": "192.***.***.120",
"NetworkType": "Private",
"Port": "3306",
"SubnetId": "subnet-3jhizp4kh5r0g3pncmfdh****"
}
],
"AutoAddNewNodes": false,
"ConsistLevel": "Global",
"ConsistTimeout": 0,
"ConsistTimeoutAction": "ReadMaster",
"ConnectionPool": "Off"
"Description": "主节点终端",
"DistributedTransaction": false,
"EndpointId": "vedbm-53vb4ido****-Primary",
"EndpointName": "主节点终端",
"EndpointType": "Primary",
"MasterAcceptReadRequests": true,
"NodeIds": [
"vedbm-53vb4ido****-1"
],
"ReadWriteMode": "ReadWrite"
},
{
"Addresses": [
{
"DNSVisibility": false,
"Domain": "vedbm-53vb4ido****.default.mysql.vedb.ivolces.com",
"EipId": "",
"IPAddress": "192.***.***.80",
"NetworkType": "Private",
"Port": "3306",
"SubnetId": "subnet-3jhizp4kh5r0g3pncmfdh****"
}
],
"AutoAddNewNodes": true,
"ConsistLevel": "Session",
"ConsistTimeout": 20000,
"ConsistTimeoutAction": "ReadMaster",
"ConnectionPool": "Off"
"Description": "默认终端",
"DistributedTransaction": true,
"EndpointId": "vedbm-53vb4ido****-ReadWriteSplit",
"EndpointName": "默认终端",
"EndpointType": "Cluster",
"MasterAcceptReadRequests": true,
"NodeIds": [
"vedbm-53vb4ido****-2",
"vedbm-53vb4ido****-1"
],
"ReadWriteMode": "ReadWrite"
},
{
"Addresses": [
{
"DNSVisibility": false,
"Domain": "vedbm-53vb4ido****.custom-mwn8.mysql.vedb.ivolces.com",
"EipId": "",
"IPAddress": "192.***.***.175",
"NetworkType": "Private",
"Port": "3306",
"SubnetId": "subnet-3jhizp4kh5r0g3pncmfdh****"
}
],
"AutoAddNewNodes": true,
"ConsistLevel": "Session",
"ConsistTimeout": 10000,
"ConsistTimeoutAction": "ReadMaster",
"ConnectionPool": "Off"
"Description": "",
"DistributedTransaction": false,
"EndpointId": "vedbm-53vb4ido****-Custom-mwn8",
"EndpointName": "自定义终端",
"EndpointType": "Custom",
"MasterAcceptReadRequests": true,
"NodeIds": [
"vedbm-53vb4ido****-0",
"vedbm-53vb4ido****-2",
"vedbm-53vb4ido****-1"
],
"ReadWriteMode": "ReadWrite"
}
],
"Total": 3
}
}
错误码
最近更新时间：2026.07.31 10:06:26
这个页面对您有帮助吗？
有用
有用
无用
无用