published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
连接终端是云数据库 MySQL 版提供的位于数据库和应用程序之间的网络代理服务。根据连接终端的功能差异,连接终端可以分为代理终端和直连终端两种类型。通过代理终端的连接将经过代理,可使用代理相关的特性和功能,如读写分离、负载均衡、空闲连接回收和 Multi-Statements 等;通过直连终端的连接将直连到对应节点,不能使用代理相关特性。
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
rdsMysqlEndpointDemo:
type: bytepluscc:rdsmysql:Endpoint
name: RdsMysqlEndpointDemo
properties:
autoAddNewNodes: false
connectionMode: Proxy
connectionPoolType: Transaction
description: this is a description
enableConnectionPersistent: true
endpointName: ccapi-test-1
endpointType: Custom
idleConnectionReclaim: true
implicitTransSplit: true
instanceId: mysql-2e229xxxxxd5
masterNodeRouting: false
masterProtectorTimeout: 60
multiStatementsMode: Strict
nodes: Primary,mysql-2e229xxxxxdd5-r442d,mysql-2e2xxxxxdd5-r8d0f
overloadProtection: true
readOnlyNodeDistributionType: RoundRobinCustom
readOnlyNodeMaxDelayTime: 30
readOnlyNodeWeights:
- node_id: ""
node_type: Primary
weight: 100
- node_id: mysql-2e2xxxxx4dd5-r442d
node_type: ReadOnly
weight: 200
- node_id: mysql-2e22xxxxxdd5-r8d0f
node_type: ReadOnly
weight: 300
readWriteMode: ReadWrite
readWriteSpliting: true
Create Endpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Endpoint(name: string, args?: EndpointArgs, opts?: CustomResourceOptions);@overload
def Endpoint(resource_name: str,
args: Optional[EndpointArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Endpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
addresses: Optional[Sequence[EndpointAddressArgs]] = None,
auto_add_new_nodes: Optional[bool] = None,
connect_all_slave_nodes: Optional[bool] = None,
connection_mode: Optional[str] = None,
connection_pool_type: Optional[str] = None,
description: Optional[str] = None,
enable_connection_persistent: Optional[bool] = None,
endpoint_name: Optional[str] = None,
endpoint_type: Optional[str] = None,
idle_connection_reclaim: Optional[bool] = None,
implicit_trans_split: Optional[bool] = None,
instance_id: Optional[str] = None,
master_node_routing: Optional[bool] = None,
master_protector_timeout: Optional[int] = None,
multi_statements_mode: Optional[str] = None,
nodes: Optional[str] = None,
overload_protection: Optional[bool] = None,
read_only_node_distribution_type: Optional[str] = None,
read_only_node_max_delay_time: Optional[int] = None,
read_only_node_weights: Optional[Sequence[EndpointReadOnlyNodeWeightArgs]] = None,
read_write_mode: Optional[str] = None,
read_write_spliting: Optional[bool] = None)func NewEndpoint(ctx *Context, name string, args *EndpointArgs, opts ...ResourceOption) (*Endpoint, error)public Endpoint(string name, EndpointArgs? args = null, CustomResourceOptions? opts = null)
public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
type: bytepluscc:rdsmysql:Endpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var byteplusccEndpointResource = new Bytepluscc.Rdsmysql.Endpoint("byteplusccEndpointResource", new()
{
Addresses = new[]
{
new Bytepluscc.Rdsmysql.Inputs.EndpointAddressArgs
{
DnsVisibility = false,
DomainPrefix = "string",
Port = "string",
},
},
AutoAddNewNodes = false,
ConnectAllSlaveNodes = false,
ConnectionMode = "string",
ConnectionPoolType = "string",
Description = "string",
EnableConnectionPersistent = false,
EndpointName = "string",
EndpointType = "string",
IdleConnectionReclaim = false,
ImplicitTransSplit = false,
InstanceId = "string",
MasterNodeRouting = false,
MasterProtectorTimeout = 0,
MultiStatementsMode = "string",
Nodes = "string",
OverloadProtection = false,
ReadOnlyNodeDistributionType = "string",
ReadOnlyNodeMaxDelayTime = 0,
ReadOnlyNodeWeights = new[]
{
new Bytepluscc.Rdsmysql.Inputs.EndpointReadOnlyNodeWeightArgs
{
NodeId = "string",
NodeType = "string",
Weight = 0,
},
},
ReadWriteMode = "string",
ReadWriteSpliting = false,
});
example, err := rdsmysql.NewEndpoint(ctx, "byteplusccEndpointResource", &rdsmysql.EndpointArgs{
Addresses: rdsmysql.EndpointAddressArray{
&rdsmysql.EndpointAddressArgs{
DnsVisibility: pulumi.Bool(false),
DomainPrefix: pulumi.String("string"),
Port: pulumi.String("string"),
},
},
AutoAddNewNodes: pulumi.Bool(false),
ConnectAllSlaveNodes: pulumi.Bool(false),
ConnectionMode: pulumi.String("string"),
ConnectionPoolType: pulumi.String("string"),
Description: pulumi.String("string"),
EnableConnectionPersistent: pulumi.Bool(false),
EndpointName: pulumi.String("string"),
EndpointType: pulumi.String("string"),
IdleConnectionReclaim: pulumi.Bool(false),
ImplicitTransSplit: pulumi.Bool(false),
InstanceId: pulumi.String("string"),
MasterNodeRouting: pulumi.Bool(false),
MasterProtectorTimeout: pulumi.Int(0),
MultiStatementsMode: pulumi.String("string"),
Nodes: pulumi.String("string"),
OverloadProtection: pulumi.Bool(false),
ReadOnlyNodeDistributionType: pulumi.String("string"),
ReadOnlyNodeMaxDelayTime: pulumi.Int(0),
ReadOnlyNodeWeights: rdsmysql.EndpointReadOnlyNodeWeightArray{
&rdsmysql.EndpointReadOnlyNodeWeightArgs{
NodeId: pulumi.String("string"),
NodeType: pulumi.String("string"),
Weight: pulumi.Int(0),
},
},
ReadWriteMode: pulumi.String("string"),
ReadWriteSpliting: pulumi.Bool(false),
})
var byteplusccEndpointResource = new com.byteplus.bytepluscc.rdsmysql.Endpoint("byteplusccEndpointResource", com.byteplus.bytepluscc.rdsmysql.EndpointArgs.builder()
.addresses(EndpointAddressArgs.builder()
.dnsVisibility(false)
.domainPrefix("string")
.port("string")
.build())
.autoAddNewNodes(false)
.connectAllSlaveNodes(false)
.connectionMode("string")
.connectionPoolType("string")
.description("string")
.enableConnectionPersistent(false)
.endpointName("string")
.endpointType("string")
.idleConnectionReclaim(false)
.implicitTransSplit(false)
.instanceId("string")
.masterNodeRouting(false)
.masterProtectorTimeout(0)
.multiStatementsMode("string")
.nodes("string")
.overloadProtection(false)
.readOnlyNodeDistributionType("string")
.readOnlyNodeMaxDelayTime(0)
.readOnlyNodeWeights(EndpointReadOnlyNodeWeightArgs.builder()
.nodeId("string")
.nodeType("string")
.weight(0)
.build())
.readWriteMode("string")
.readWriteSpliting(false)
.build());
bytepluscc_endpoint_resource = bytepluscc.rdsmysql.Endpoint("byteplusccEndpointResource",
addresses=[{
"dns_visibility": False,
"domain_prefix": "string",
"port": "string",
}],
auto_add_new_nodes=False,
connect_all_slave_nodes=False,
connection_mode="string",
connection_pool_type="string",
description="string",
enable_connection_persistent=False,
endpoint_name="string",
endpoint_type="string",
idle_connection_reclaim=False,
implicit_trans_split=False,
instance_id="string",
master_node_routing=False,
master_protector_timeout=0,
multi_statements_mode="string",
nodes="string",
overload_protection=False,
read_only_node_distribution_type="string",
read_only_node_max_delay_time=0,
read_only_node_weights=[{
"node_id": "string",
"node_type": "string",
"weight": 0,
}],
read_write_mode="string",
read_write_spliting=False)
const byteplusccEndpointResource = new bytepluscc.rdsmysql.Endpoint("byteplusccEndpointResource", {
addresses: [{
dnsVisibility: false,
domainPrefix: "string",
port: "string",
}],
autoAddNewNodes: false,
connectAllSlaveNodes: false,
connectionMode: "string",
connectionPoolType: "string",
description: "string",
enableConnectionPersistent: false,
endpointName: "string",
endpointType: "string",
idleConnectionReclaim: false,
implicitTransSplit: false,
instanceId: "string",
masterNodeRouting: false,
masterProtectorTimeout: 0,
multiStatementsMode: "string",
nodes: "string",
overloadProtection: false,
readOnlyNodeDistributionType: "string",
readOnlyNodeMaxDelayTime: 0,
readOnlyNodeWeights: [{
nodeId: "string",
nodeType: "string",
weight: 0,
}],
readWriteMode: "string",
readWriteSpliting: false,
});
type: bytepluscc:rdsmysql:Endpoint
properties:
addresses:
- dnsVisibility: false
domainPrefix: string
port: string
autoAddNewNodes: false
connectAllSlaveNodes: false
connectionMode: string
connectionPoolType: string
description: string
enableConnectionPersistent: false
endpointName: string
endpointType: string
idleConnectionReclaim: false
implicitTransSplit: false
instanceId: string
masterNodeRouting: false
masterProtectorTimeout: 0
multiStatementsMode: string
nodes: string
overloadProtection: false
readOnlyNodeDistributionType: string
readOnlyNodeMaxDelayTime: 0
readOnlyNodeWeights:
- nodeId: string
nodeType: string
weight: 0
readWriteMode: string
readWriteSpliting: false
Endpoint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Endpoint resource accepts the following input properties:
- Addresses
List<Byteplus.
Endpoint Address> - Auto
Add boolNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- Connect
All boolSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- Connection
Mode string - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- Connection
Pool stringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- Description string
- 备注。
- Enable
Connection boolPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- Endpoint
Name string - 实例连接终端名称。
- Endpoint
Type string - 终端类型。取值为 Custom,自定义终端。
- Idle
Connection boolReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- Implicit
Trans boolSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Instance
Id string - 实例 ID。
- Master
Node boolRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Master
Protector intTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- Multi
Statements stringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- Nodes string
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- Overload
Protection bool - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Read
Only stringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- Read
Only intNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- Read
Only List<Byteplus.Node Weights Endpoint Read Only Node Weight> - Read
Write stringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- Read
Write boolSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- Addresses
[]Endpoint
Address Args - Auto
Add boolNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- Connect
All boolSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- Connection
Mode string - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- Connection
Pool stringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- Description string
- 备注。
- Enable
Connection boolPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- Endpoint
Name string - 实例连接终端名称。
- Endpoint
Type string - 终端类型。取值为 Custom,自定义终端。
- Idle
Connection boolReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- Implicit
Trans boolSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Instance
Id string - 实例 ID。
- Master
Node boolRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Master
Protector intTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- Multi
Statements stringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- Nodes string
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- Overload
Protection bool - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Read
Only stringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- Read
Only intNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- Read
Only []EndpointNode Weights Read Only Node Weight Args - Read
Write stringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- Read
Write boolSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses
List<Endpoint
Address> - auto
Add BooleanNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect
All BooleanSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- connection
Mode String - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection
Pool StringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- description String
- 备注。
- enable
Connection BooleanPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- endpoint
Name String - 实例连接终端名称。
- endpoint
Type String - 终端类型。取值为 Custom,自定义终端。
- idle
Connection BooleanReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit
Trans BooleanSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance
Id String - 实例 ID。
- master
Node BooleanRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master
Protector IntegerTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi
Statements StringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes String
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload
Protection Boolean - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read
Only StringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read
Only IntegerNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read
Only List<EndpointNode Weights Read Only Node Weight> - read
Write StringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read
Write BooleanSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses
Endpoint
Address[] - auto
Add booleanNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect
All booleanSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- connection
Mode string - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection
Pool stringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- description string
- 备注。
- enable
Connection booleanPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- endpoint
Name string - 实例连接终端名称。
- endpoint
Type string - 终端类型。取值为 Custom,自定义终端。
- idle
Connection booleanReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit
Trans booleanSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance
Id string - 实例 ID。
- master
Node booleanRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master
Protector numberTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi
Statements stringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes string
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload
Protection boolean - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read
Only stringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read
Only numberNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read
Only EndpointNode Weights Read Only Node Weight[] - read
Write stringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read
Write booleanSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses
Sequence[Endpoint
Address Args] - auto_
add_ boolnew_ nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect_
all_ boolslave_ nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- connection_
mode str - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection_
pool_ strtype - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- description str
- 备注。
- enable_
connection_ boolpersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- endpoint_
name str - 实例连接终端名称。
- endpoint_
type str - 终端类型。取值为 Custom,自定义终端。
- idle_
connection_ boolreclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit_
trans_ boolsplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance_
id str - 实例 ID。
- master_
node_ boolrouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master_
protector_ inttimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi_
statements_ strmode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes str
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload_
protection bool - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read_
only_ strnode_ distribution_ type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read_
only_ intnode_ max_ delay_ time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read_
only_ Sequence[Endpointnode_ weights Read Only Node Weight Args] - read_
write_ strmode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read_
write_ boolspliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses List<Property Map>
- auto
Add BooleanNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect
All BooleanSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- connection
Mode String - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection
Pool StringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- description String
- 备注。
- enable
Connection BooleanPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- endpoint
Name String - 实例连接终端名称。
- endpoint
Type String - 终端类型。取值为 Custom,自定义终端。
- idle
Connection BooleanReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit
Trans BooleanSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance
Id String - 实例 ID。
- master
Node BooleanRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master
Protector NumberTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi
Statements StringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes String
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload
Protection Boolean - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read
Only StringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read
Only NumberNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read
Only List<Property Map>Node Weights - read
Write StringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read
Write BooleanSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
Outputs
All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:
- List<string>
- 连接终端标签。
- Custom
Route Byteplus.Strategy Endpoint Custom Route Strategy - 连接终端的 SQL 转发规则。
- Enable
Read stringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- Endpoint
Id string - 实例连接终端 ID。
- Id string
- The provider-assigned unique ID for this managed resource.
- []string
- 连接终端标签。
- Custom
Route EndpointStrategy Custom Route Strategy - 连接终端的 SQL 转发规则。
- Enable
Read stringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- Endpoint
Id string - 实例连接终端 ID。
- Id string
- The provider-assigned unique ID for this managed resource.
- List<String>
- 连接终端标签。
- custom
Route EndpointStrategy Custom Route Strategy - 连接终端的 SQL 转发规则。
- enable
Read StringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint
Id String - 实例连接终端 ID。
- id String
- The provider-assigned unique ID for this managed resource.
- string[]
- 连接终端标签。
- custom
Route EndpointStrategy Custom Route Strategy - 连接终端的 SQL 转发规则。
- enable
Read stringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint
Id string - 实例连接终端 ID。
- id string
- The provider-assigned unique ID for this managed resource.
- Sequence[str]
- 连接终端标签。
- custom_
route_ Endpointstrategy Custom Route Strategy - 连接终端的 SQL 转发规则。
- enable_
read_ stronly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint_
id str - 实例连接终端 ID。
- id str
- The provider-assigned unique ID for this managed resource.
- List<String>
- 连接终端标签。
- custom
Route Property MapStrategy - 连接终端的 SQL 转发规则。
- enable
Read StringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint
Id String - 实例连接终端 ID。
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Endpoint Resource
Get an existing Endpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EndpointState, opts?: CustomResourceOptions): Endpoint@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
addresses: Optional[Sequence[EndpointAddressArgs]] = None,
auto_add_new_nodes: Optional[bool] = None,
connect_all_slave_nodes: Optional[bool] = None,
connection_info_tags: Optional[Sequence[str]] = None,
connection_mode: Optional[str] = None,
connection_pool_type: Optional[str] = None,
custom_route_strategy: Optional[EndpointCustomRouteStrategyArgs] = None,
description: Optional[str] = None,
enable_connection_persistent: Optional[bool] = None,
enable_read_only: Optional[str] = None,
endpoint_id: Optional[str] = None,
endpoint_name: Optional[str] = None,
endpoint_type: Optional[str] = None,
idle_connection_reclaim: Optional[bool] = None,
implicit_trans_split: Optional[bool] = None,
instance_id: Optional[str] = None,
master_node_routing: Optional[bool] = None,
master_protector_timeout: Optional[int] = None,
multi_statements_mode: Optional[str] = None,
nodes: Optional[str] = None,
overload_protection: Optional[bool] = None,
read_only_node_distribution_type: Optional[str] = None,
read_only_node_max_delay_time: Optional[int] = None,
read_only_node_weights: Optional[Sequence[EndpointReadOnlyNodeWeightArgs]] = None,
read_write_mode: Optional[str] = None,
read_write_spliting: Optional[bool] = None) -> Endpointfunc GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)resources: _: type: bytepluscc:rdsmysql:Endpoint get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Addresses
List<Byteplus.
Endpoint Address> - Auto
Add boolNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- Connect
All boolSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- List<string>
- 连接终端标签。
- Connection
Mode string - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- Connection
Pool stringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- Custom
Route Byteplus.Strategy Endpoint Custom Route Strategy - 连接终端的 SQL 转发规则。
- Description string
- 备注。
- Enable
Connection boolPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- Enable
Read stringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- Endpoint
Id string - 实例连接终端 ID。
- Endpoint
Name string - 实例连接终端名称。
- Endpoint
Type string - 终端类型。取值为 Custom,自定义终端。
- Idle
Connection boolReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- Implicit
Trans boolSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Instance
Id string - 实例 ID。
- Master
Node boolRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Master
Protector intTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- Multi
Statements stringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- Nodes string
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- Overload
Protection bool - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Read
Only stringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- Read
Only intNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- Read
Only List<Byteplus.Node Weights Endpoint Read Only Node Weight> - Read
Write stringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- Read
Write boolSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- Addresses
[]Endpoint
Address Args - Auto
Add boolNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- Connect
All boolSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- []string
- 连接终端标签。
- Connection
Mode string - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- Connection
Pool stringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- Custom
Route EndpointStrategy Custom Route Strategy Args - 连接终端的 SQL 转发规则。
- Description string
- 备注。
- Enable
Connection boolPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- Enable
Read stringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- Endpoint
Id string - 实例连接终端 ID。
- Endpoint
Name string - 实例连接终端名称。
- Endpoint
Type string - 终端类型。取值为 Custom,自定义终端。
- Idle
Connection boolReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- Implicit
Trans boolSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Instance
Id string - 实例 ID。
- Master
Node boolRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Master
Protector intTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- Multi
Statements stringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- Nodes string
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- Overload
Protection bool - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- Read
Only stringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- Read
Only intNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- Read
Only []EndpointNode Weights Read Only Node Weight Args - Read
Write stringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- Read
Write boolSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses
List<Endpoint
Address> - auto
Add BooleanNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect
All BooleanSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- List<String>
- 连接终端标签。
- connection
Mode String - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection
Pool StringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- custom
Route EndpointStrategy Custom Route Strategy - 连接终端的 SQL 转发规则。
- description String
- 备注。
- enable
Connection BooleanPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- enable
Read StringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint
Id String - 实例连接终端 ID。
- endpoint
Name String - 实例连接终端名称。
- endpoint
Type String - 终端类型。取值为 Custom,自定义终端。
- idle
Connection BooleanReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit
Trans BooleanSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance
Id String - 实例 ID。
- master
Node BooleanRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master
Protector IntegerTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi
Statements StringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes String
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload
Protection Boolean - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read
Only StringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read
Only IntegerNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read
Only List<EndpointNode Weights Read Only Node Weight> - read
Write StringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read
Write BooleanSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses
Endpoint
Address[] - auto
Add booleanNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect
All booleanSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- string[]
- 连接终端标签。
- connection
Mode string - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection
Pool stringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- custom
Route EndpointStrategy Custom Route Strategy - 连接终端的 SQL 转发规则。
- description string
- 备注。
- enable
Connection booleanPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- enable
Read stringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint
Id string - 实例连接终端 ID。
- endpoint
Name string - 实例连接终端名称。
- endpoint
Type string - 终端类型。取值为 Custom,自定义终端。
- idle
Connection booleanReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit
Trans booleanSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance
Id string - 实例 ID。
- master
Node booleanRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master
Protector numberTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi
Statements stringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes string
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload
Protection boolean - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read
Only stringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read
Only numberNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read
Only EndpointNode Weights Read Only Node Weight[] - read
Write stringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read
Write booleanSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses
Sequence[Endpoint
Address Args] - auto_
add_ boolnew_ nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect_
all_ boolslave_ nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- Sequence[str]
- 连接终端标签。
- connection_
mode str - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection_
pool_ strtype - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- custom_
route_ Endpointstrategy Custom Route Strategy Args - 连接终端的 SQL 转发规则。
- description str
- 备注。
- enable_
connection_ boolpersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- enable_
read_ stronly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint_
id str - 实例连接终端 ID。
- endpoint_
name str - 实例连接终端名称。
- endpoint_
type str - 终端类型。取值为 Custom,自定义终端。
- idle_
connection_ boolreclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit_
trans_ boolsplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance_
id str - 实例 ID。
- master_
node_ boolrouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master_
protector_ inttimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi_
statements_ strmode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes str
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload_
protection bool - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read_
only_ strnode_ distribution_ type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read_
only_ intnode_ max_ delay_ time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read_
only_ Sequence[Endpointnode_ weights Read Only Node Weight Args] - read_
write_ strmode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read_
write_ boolspliting - 是否开启读写分离。取值:true:是。默认值。false:否。
- addresses List<Property Map>
- auto
Add BooleanNew Nodes - 当终端类型为读写终端或只读终端时,支持设置新节点是否自动加入。取值:true:自动加入。false:不自动加入(默认)。
- connect
All BooleanSlave Nodes - 是否关联所有的备节点。取值:true:是。默认值。false:否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
- List<String>
- 连接终端标签。
- connection
Mode String - 连接终端类型。取值:Proxy:代理终端。Direct:直连终端。说明如实例的数据库代理功能已开启,可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启,仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
- connection
Pool StringType - 代理终端的连接池类型。取值:Transaction:事务级连接池。默认值。Direct:直连模式。说明单节点实例不支持该功能。
- custom
Route Property MapStrategy - 连接终端的 SQL 转发规则。
- description String
- 备注。
- enable
Connection BooleanPersistent - 是否开启连接终端的连接保持功能。取值:true:是。false:否。说明仅代理终端支持该设置。
- enable
Read StringOnly - 是否已开启全局只读,取值:Enable:开启。Disable:未开启。
- endpoint
Id String - 实例连接终端 ID。
- endpoint
Name String - 实例连接终端名称。
- endpoint
Type String - 终端类型。取值为 Custom,自定义终端。
- idle
Connection BooleanReclaim - 空闲连接回收功能是否开启。true:开启。false:不开启。说明仅代理终端会返回该字段。
- implicit
Trans BooleanSplit - 是否开启事务分离。取值:true:是。false:否。说明仅代理终端会返回该字段。
- instance
Id String - 实例 ID。
- master
Node BooleanRouting - 是否开启主节点路由。取值:true:是。false:否。说明仅代理终端会返回该字段。
- master
Protector NumberTimeout - 过载保护超时时间。取值范围为 60~7200 之间的整数,单位为秒。说明仅代理终端会返回该字段。
- multi
Statements StringMode - 代理终端的 Multi-Statements 模式。取值:Strict:Strict 模式。默认值。Loose:Loose 模式。
- nodes String
- 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端,不需填写主节点 ID,只需填写 Primary。多个节点 ID 之间用英文逗号(,)分隔。
- overload
Protection Boolean - 是否开启过载保护。取值:true:是。false:否。说明仅代理终端会返回该字段。
- read
Only StringNode Distribution Type - 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时,取值范围如下:LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时,取值范围如下:Default:按规格权重自动分配。Custom:自定义分配权重。RoundRobin:轮询调度。LoadSchedule:负载调度。RoundRobinCustom:自定义权重的轮询调度。RoundRobinAuto:自动分配权重的轮询调度。
- read
Only NumberNode Max Delay Time - 只读节点延迟阈值。取值范围为 1~3600,默认为 30,单位为秒。
- read
Only List<Property Map>Node Weights - read
Write StringMode - 读写模式:ReadWrite:读写。ReadOnly:只读。
- read
Write BooleanSpliting - 是否开启读写分离。取值:true:是。默认值。false:否。
Supporting Types
EndpointAddress, EndpointAddressArgs
- Dns
Visibility bool - false:火山引擎私网解析(默认)。true:火山引擎私网以及公网解析。
- Domain
Prefix string - 连接地址前缀。连接地址的前缀需满足以下规则:以小写字母开头,以小写字母或数字结尾。由小写字母、数字和中划线(-)中的至少两种组成。连接地址前缀应至少包含 8 个字符,连接地址总长度(前缀+后缀)不得超过 63个字符。
- Port string
- 端口。
- Dns
Visibility bool - false:火山引擎私网解析(默认)。true:火山引擎私网以及公网解析。
- Domain
Prefix string - 连接地址前缀。连接地址的前缀需满足以下规则:以小写字母开头,以小写字母或数字结尾。由小写字母、数字和中划线(-)中的至少两种组成。连接地址前缀应至少包含 8 个字符,连接地址总长度(前缀+后缀)不得超过 63个字符。
- Port string
- 端口。
- dns
Visibility Boolean - false:火山引擎私网解析(默认)。true:火山引擎私网以及公网解析。
- domain
Prefix String - 连接地址前缀。连接地址的前缀需满足以下规则:以小写字母开头,以小写字母或数字结尾。由小写字母、数字和中划线(-)中的至少两种组成。连接地址前缀应至少包含 8 个字符,连接地址总长度(前缀+后缀)不得超过 63个字符。
- port String
- 端口。
- dns
Visibility boolean - false:火山引擎私网解析(默认)。true:火山引擎私网以及公网解析。
- domain
Prefix string - 连接地址前缀。连接地址的前缀需满足以下规则:以小写字母开头,以小写字母或数字结尾。由小写字母、数字和中划线(-)中的至少两种组成。连接地址前缀应至少包含 8 个字符,连接地址总长度(前缀+后缀)不得超过 63个字符。
- port string
- 端口。
- dns_
visibility bool - false:火山引擎私网解析(默认)。true:火山引擎私网以及公网解析。
- domain_
prefix str - 连接地址前缀。连接地址的前缀需满足以下规则:以小写字母开头,以小写字母或数字结尾。由小写字母、数字和中划线(-)中的至少两种组成。连接地址前缀应至少包含 8 个字符,连接地址总长度(前缀+后缀)不得超过 63个字符。
- port str
- 端口。
- dns
Visibility Boolean - false:火山引擎私网解析(默认)。true:火山引擎私网以及公网解析。
- domain
Prefix String - 连接地址前缀。连接地址的前缀需满足以下规则:以小写字母开头,以小写字母或数字结尾。由小写字母、数字和中划线(-)中的至少两种组成。连接地址前缀应至少包含 8 个字符,连接地址总长度(前缀+后缀)不得超过 63个字符。
- port String
- 端口。
EndpointCustomRouteStrategy, EndpointCustomRouteStrategyArgs
EndpointCustomRouteStrategyKeywordRouteStrategy, EndpointCustomRouteStrategyKeywordRouteStrategyArgs
- Node
Type string - SQL 转发规则的转发目标。取值:Primary:主节点。Secondary:备节点。ReadOnly:只读节点。说明如实例为双节点实例,可选择主节点或只读节点。如实例为多节点实例,可选择主节点或备节点。
- Sql
Keyword string - 转发规则的关键字。SQL 关键字的设置规则如下:单个规则最多可包含 20 个关键字。最大长度为 64 个字符,可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。
- Node
Type string - SQL 转发规则的转发目标。取值:Primary:主节点。Secondary:备节点。ReadOnly:只读节点。说明如实例为双节点实例,可选择主节点或只读节点。如实例为多节点实例,可选择主节点或备节点。
- Sql
Keyword string - 转发规则的关键字。SQL 关键字的设置规则如下:单个规则最多可包含 20 个关键字。最大长度为 64 个字符,可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。
- node
Type String - SQL 转发规则的转发目标。取值:Primary:主节点。Secondary:备节点。ReadOnly:只读节点。说明如实例为双节点实例,可选择主节点或只读节点。如实例为多节点实例,可选择主节点或备节点。
- sql
Keyword String - 转发规则的关键字。SQL 关键字的设置规则如下:单个规则最多可包含 20 个关键字。最大长度为 64 个字符,可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。
- node
Type string - SQL 转发规则的转发目标。取值:Primary:主节点。Secondary:备节点。ReadOnly:只读节点。说明如实例为双节点实例,可选择主节点或只读节点。如实例为多节点实例,可选择主节点或备节点。
- sql
Keyword string - 转发规则的关键字。SQL 关键字的设置规则如下:单个规则最多可包含 20 个关键字。最大长度为 64 个字符,可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。
- node_
type str - SQL 转发规则的转发目标。取值:Primary:主节点。Secondary:备节点。ReadOnly:只读节点。说明如实例为双节点实例,可选择主节点或只读节点。如实例为多节点实例,可选择主节点或备节点。
- sql_
keyword str - 转发规则的关键字。SQL 关键字的设置规则如下:单个规则最多可包含 20 个关键字。最大长度为 64 个字符,可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。
- node
Type String - SQL 转发规则的转发目标。取值:Primary:主节点。Secondary:备节点。ReadOnly:只读节点。说明如实例为双节点实例,可选择主节点或只读节点。如实例为多节点实例,可选择主节点或备节点。
- sql
Keyword String - 转发规则的关键字。SQL 关键字的设置规则如下:单个规则最多可包含 20 个关键字。最大长度为 64 个字符,可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。
EndpointReadOnlyNodeWeight, EndpointReadOnlyNodeWeightArgs
Import
$ pulumi import bytepluscc:rdsmysql/endpoint:Endpoint example "instance_id|endpoint_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
published on Monday, Mar 9, 2026 by Byteplus
