bytepluscc.rdsmysql.getEndpoint

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>

def get_endpoint(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]

func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

> Note: This function is named LookupEndpoint in the Go SDK.

public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:rdsmysql/getEndpoint:getEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getEndpoint Result

The following output properties are available:

Addresses List<Byteplus.GetEndpointAddress>: 终端节点地址列表。
AutoAddNewNodes bool: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：true：自动加入。false：不自动加入（默认）。
ConnectAllSlaveNodes bool: 是否关联所有的备节点。取值：true：是。默认值。false：否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
ConnectionInfoTags List<string>: 连接终端标签。
ConnectionMode string: 连接终端类型。取值：Proxy：代理终端。Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
ConnectionPoolType string: 代理终端的连接池类型。取值：Transaction：事务级连接池。默认值。Direct：直连模式。说明单节点实例不支持该功能。
CustomRouteStrategy Byteplus.GetEndpointCustomRouteStrategy: 连接终端的 SQL 转发规则。
Description string: 备注。
EnableConnectionPersistent bool: 是否开启连接终端的连接保持功能。取值：true：是。false：否。说明仅代理终端支持该设置。
EnableReadOnly string: 是否已开启全局只读，取值：Enable：开启。Disable：未开启。
EndpointId string: 实例连接终端 ID。
EndpointName string: 实例连接终端名称。
EndpointType string: 终端类型。取值为 Custom，自定义终端。
Id string: Uniquely identifies the resource.
IdleConnectionReclaim bool: 空闲连接回收功能是否开启。true：开启。false：不开启。说明仅代理终端会返回该字段。
ImplicitTransSplit bool: 是否开启事务分离。取值：true：是。false：否。说明仅代理终端会返回该字段。
InstanceId string: 实例 ID。
MasterNodeRouting bool: 是否开启主节点路由。取值：true：是。false：否。说明仅代理终端会返回该字段。
MasterProtectorTimeout int: 过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
MultiStatementsMode string: 代理终端的 Multi-Statements 模式。取值：Strict：Strict 模式。默认值。Loose：Loose 模式。
Nodes string: 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。
OverloadProtection bool: 是否开启过载保护。取值：true：是。false：否。说明仅代理终端会返回该字段。
ReadOnlyNodeDistributionType string: 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下：LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下：Default：按规格权重自动分配。Custom：自定义分配权重。RoundRobin：轮询调度。LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。
ReadOnlyNodeMaxDelayTime int: 只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
ReadOnlyNodeWeights List<Byteplus.GetEndpointReadOnlyNodeWeight>: 连接终端配置的节点列表及对应的只读权重。
ReadWriteMode string: 读写模式：ReadWrite：读写。ReadOnly：只读。
ReadWriteSpliting bool: 是否开启读写分离。取值：true：是。默认值。false：否。

Addresses []GetEndpointAddress: 终端节点地址列表。
AutoAddNewNodes bool: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：true：自动加入。false：不自动加入（默认）。
ConnectAllSlaveNodes bool: 是否关联所有的备节点。取值：true：是。默认值。false：否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
ConnectionInfoTags []string: 连接终端标签。
ConnectionMode string: 连接终端类型。取值：Proxy：代理终端。Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
ConnectionPoolType string: 代理终端的连接池类型。取值：Transaction：事务级连接池。默认值。Direct：直连模式。说明单节点实例不支持该功能。
CustomRouteStrategy GetEndpointCustomRouteStrategy: 连接终端的 SQL 转发规则。
Description string: 备注。
EnableConnectionPersistent bool: 是否开启连接终端的连接保持功能。取值：true：是。false：否。说明仅代理终端支持该设置。
EnableReadOnly string: 是否已开启全局只读，取值：Enable：开启。Disable：未开启。
EndpointId string: 实例连接终端 ID。
EndpointName string: 实例连接终端名称。
EndpointType string: 终端类型。取值为 Custom，自定义终端。
Id string: Uniquely identifies the resource.
IdleConnectionReclaim bool: 空闲连接回收功能是否开启。true：开启。false：不开启。说明仅代理终端会返回该字段。
ImplicitTransSplit bool: 是否开启事务分离。取值：true：是。false：否。说明仅代理终端会返回该字段。
InstanceId string: 实例 ID。
MasterNodeRouting bool: 是否开启主节点路由。取值：true：是。false：否。说明仅代理终端会返回该字段。
MasterProtectorTimeout int: 过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
MultiStatementsMode string: 代理终端的 Multi-Statements 模式。取值：Strict：Strict 模式。默认值。Loose：Loose 模式。
Nodes string: 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。
OverloadProtection bool: 是否开启过载保护。取值：true：是。false：否。说明仅代理终端会返回该字段。
ReadOnlyNodeDistributionType string: 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下：LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下：Default：按规格权重自动分配。Custom：自定义分配权重。RoundRobin：轮询调度。LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。
ReadOnlyNodeMaxDelayTime int: 只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
ReadOnlyNodeWeights []GetEndpointReadOnlyNodeWeight: 连接终端配置的节点列表及对应的只读权重。
ReadWriteMode string: 读写模式：ReadWrite：读写。ReadOnly：只读。
ReadWriteSpliting bool: 是否开启读写分离。取值：true：是。默认值。false：否。

addresses List<GetEndpointAddress>: 终端节点地址列表。
autoAddNewNodes Boolean: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：true：自动加入。false：不自动加入（默认）。
connectAllSlaveNodes Boolean: 是否关联所有的备节点。取值：true：是。默认值。false：否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
connectionInfoTags List<String>: 连接终端标签。
connectionMode String: 连接终端类型。取值：Proxy：代理终端。Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
connectionPoolType String: 代理终端的连接池类型。取值：Transaction：事务级连接池。默认值。Direct：直连模式。说明单节点实例不支持该功能。
customRouteStrategy GetEndpointCustomRouteStrategy: 连接终端的 SQL 转发规则。
description String: 备注。
enableConnectionPersistent Boolean: 是否开启连接终端的连接保持功能。取值：true：是。false：否。说明仅代理终端支持该设置。
enableReadOnly String: 是否已开启全局只读，取值：Enable：开启。Disable：未开启。
endpointId String: 实例连接终端 ID。
endpointName String: 实例连接终端名称。
endpointType String: 终端类型。取值为 Custom，自定义终端。
id String: Uniquely identifies the resource.
idleConnectionReclaim Boolean: 空闲连接回收功能是否开启。true：开启。false：不开启。说明仅代理终端会返回该字段。
implicitTransSplit Boolean: 是否开启事务分离。取值：true：是。false：否。说明仅代理终端会返回该字段。
instanceId String: 实例 ID。
masterNodeRouting Boolean: 是否开启主节点路由。取值：true：是。false：否。说明仅代理终端会返回该字段。
masterProtectorTimeout Integer: 过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
multiStatementsMode String: 代理终端的 Multi-Statements 模式。取值：Strict：Strict 模式。默认值。Loose：Loose 模式。
nodes String: 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。
overloadProtection Boolean: 是否开启过载保护。取值：true：是。false：否。说明仅代理终端会返回该字段。
readOnlyNodeDistributionType String: 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下：LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下：Default：按规格权重自动分配。Custom：自定义分配权重。RoundRobin：轮询调度。LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。
readOnlyNodeMaxDelayTime Integer: 只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
readOnlyNodeWeights List<GetEndpointReadOnlyNodeWeight>: 连接终端配置的节点列表及对应的只读权重。
readWriteMode String: 读写模式：ReadWrite：读写。ReadOnly：只读。
readWriteSpliting Boolean: 是否开启读写分离。取值：true：是。默认值。false：否。

addresses GetEndpointAddress[]: 终端节点地址列表。
autoAddNewNodes boolean: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：true：自动加入。false：不自动加入（默认）。
connectAllSlaveNodes boolean: 是否关联所有的备节点。取值：true：是。默认值。false：否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
connectionInfoTags string[]: 连接终端标签。
connectionMode string: 连接终端类型。取值：Proxy：代理终端。Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
connectionPoolType string: 代理终端的连接池类型。取值：Transaction：事务级连接池。默认值。Direct：直连模式。说明单节点实例不支持该功能。
customRouteStrategy GetEndpointCustomRouteStrategy: 连接终端的 SQL 转发规则。
description string: 备注。
enableConnectionPersistent boolean: 是否开启连接终端的连接保持功能。取值：true：是。false：否。说明仅代理终端支持该设置。
enableReadOnly string: 是否已开启全局只读，取值：Enable：开启。Disable：未开启。
endpointId string: 实例连接终端 ID。
endpointName string: 实例连接终端名称。
endpointType string: 终端类型。取值为 Custom，自定义终端。
id string: Uniquely identifies the resource.
idleConnectionReclaim boolean: 空闲连接回收功能是否开启。true：开启。false：不开启。说明仅代理终端会返回该字段。
implicitTransSplit boolean: 是否开启事务分离。取值：true：是。false：否。说明仅代理终端会返回该字段。
instanceId string: 实例 ID。
masterNodeRouting boolean: 是否开启主节点路由。取值：true：是。false：否。说明仅代理终端会返回该字段。
masterProtectorTimeout number: 过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
multiStatementsMode string: 代理终端的 Multi-Statements 模式。取值：Strict：Strict 模式。默认值。Loose：Loose 模式。
nodes string: 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。
overloadProtection boolean: 是否开启过载保护。取值：true：是。false：否。说明仅代理终端会返回该字段。
readOnlyNodeDistributionType string: 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下：LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下：Default：按规格权重自动分配。Custom：自定义分配权重。RoundRobin：轮询调度。LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。
readOnlyNodeMaxDelayTime number: 只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
readOnlyNodeWeights GetEndpointReadOnlyNodeWeight[]: 连接终端配置的节点列表及对应的只读权重。
readWriteMode string: 读写模式：ReadWrite：读写。ReadOnly：只读。
readWriteSpliting boolean: 是否开启读写分离。取值：true：是。默认值。false：否。

addresses Sequence[GetEndpointAddress]: 终端节点地址列表。
auto_add_new_nodes bool: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：true：自动加入。false：不自动加入（默认）。
connect_all_slave_nodes bool: 是否关联所有的备节点。取值：true：是。默认值。false：否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
connection_info_tags Sequence[str]: 连接终端标签。
connection_mode str: 连接终端类型。取值：Proxy：代理终端。Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
connection_pool_type str: 代理终端的连接池类型。取值：Transaction：事务级连接池。默认值。Direct：直连模式。说明单节点实例不支持该功能。
custom_route_strategy GetEndpointCustomRouteStrategy: 连接终端的 SQL 转发规则。
description str: 备注。
enable_connection_persistent bool: 是否开启连接终端的连接保持功能。取值：true：是。false：否。说明仅代理终端支持该设置。
enable_read_only str: 是否已开启全局只读，取值：Enable：开启。Disable：未开启。
endpoint_id str: 实例连接终端 ID。
endpoint_name str: 实例连接终端名称。
endpoint_type str: 终端类型。取值为 Custom，自定义终端。
id str: Uniquely identifies the resource.
idle_connection_reclaim bool: 空闲连接回收功能是否开启。true：开启。false：不开启。说明仅代理终端会返回该字段。
implicit_trans_split bool: 是否开启事务分离。取值：true：是。false：否。说明仅代理终端会返回该字段。
instance_id str: 实例 ID。
master_node_routing bool: 是否开启主节点路由。取值：true：是。false：否。说明仅代理终端会返回该字段。
master_protector_timeout int: 过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
multi_statements_mode str: 代理终端的 Multi-Statements 模式。取值：Strict：Strict 模式。默认值。Loose：Loose 模式。
nodes str: 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。
overload_protection bool: 是否开启过载保护。取值：true：是。false：否。说明仅代理终端会返回该字段。
read_only_node_distribution_type str: 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下：LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下：Default：按规格权重自动分配。Custom：自定义分配权重。RoundRobin：轮询调度。LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。
read_only_node_max_delay_time int: 只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
read_only_node_weights Sequence[GetEndpointReadOnlyNodeWeight]: 连接终端配置的节点列表及对应的只读权重。
read_write_mode str: 读写模式：ReadWrite：读写。ReadOnly：只读。
read_write_spliting bool: 是否开启读写分离。取值：true：是。默认值。false：否。

addresses List<Property Map>: 终端节点地址列表。
autoAddNewNodes Boolean: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：true：自动加入。false：不自动加入（默认）。
connectAllSlaveNodes Boolean: 是否关联所有的备节点。取值：true：是。默认值。false：否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
connectionInfoTags List<String>: 连接终端标签。
connectionMode String: 连接终端类型。取值：Proxy：代理终端。Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
connectionPoolType String: 代理终端的连接池类型。取值：Transaction：事务级连接池。默认值。Direct：直连模式。说明单节点实例不支持该功能。
customRouteStrategy Property Map: 连接终端的 SQL 转发规则。
description String: 备注。
enableConnectionPersistent Boolean: 是否开启连接终端的连接保持功能。取值：true：是。false：否。说明仅代理终端支持该设置。
enableReadOnly String: 是否已开启全局只读，取值：Enable：开启。Disable：未开启。
endpointId String: 实例连接终端 ID。
endpointName String: 实例连接终端名称。
endpointType String: 终端类型。取值为 Custom，自定义终端。
id String: Uniquely identifies the resource.
idleConnectionReclaim Boolean: 空闲连接回收功能是否开启。true：开启。false：不开启。说明仅代理终端会返回该字段。
implicitTransSplit Boolean: 是否开启事务分离。取值：true：是。false：否。说明仅代理终端会返回该字段。
instanceId String: 实例 ID。
masterNodeRouting Boolean: 是否开启主节点路由。取值：true：是。false：否。说明仅代理终端会返回该字段。
masterProtectorTimeout Number: 过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
multiStatementsMode String: 代理终端的 Multi-Statements 模式。取值：Strict：Strict 模式。默认值。Loose：Loose 模式。
nodes String: 连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。
overloadProtection Boolean: 是否开启过载保护。取值：true：是。false：否。说明仅代理终端会返回该字段。
readOnlyNodeDistributionType String: 读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下：LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下：Default：按规格权重自动分配。Custom：自定义分配权重。RoundRobin：轮询调度。LoadSchedule：负载调度。RoundRobinCustom：自定义权重的轮询调度。RoundRobinAuto：自动分配权重的轮询调度。
readOnlyNodeMaxDelayTime Number: 只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
readOnlyNodeWeights List<Property Map>: 连接终端配置的节点列表及对应的只读权重。
readWriteMode String: 读写模式：ReadWrite：读写。ReadOnly：只读。
readWriteSpliting Boolean: 是否开启读写分离。取值：true：是。默认值。false：否。

Supporting Types

GetEndpointAddress

DnsVisibility bool: false：火山引擎私网解析（默认）。true：火山引擎私网以及公网解析。
Domain string: 连接域名。
DomainPrefix string: 连接地址前缀。连接地址的前缀需满足以下规则：以小写字母开头，以小写字母或数字结尾。由小写字母、数字和中划线（-）中的至少两种组成。连接地址前缀应至少包含 8 个字符，连接地址总长度（前缀+后缀）不得超过 63个字符。
EipId string: EIP 的 ID，仅对 Public 地址有效。
EipLocked bool: 连接终端使用的 EIP 是否因欠费关停。取值：true：是。false：否。
InternetProtocol string: IP 协议版本。取值为 IPv4。
IpAddress string: IP 地址。
NetworkType string: 网络地址类型，取值为：Private：私网地址。Public：公网地址。
Port string: 端口。
SubnetId string: 子网 ID，仅对 Private 地址有效。

DnsVisibility bool: false：火山引擎私网解析（默认）。true：火山引擎私网以及公网解析。
Domain string: 连接域名。
DomainPrefix string: 连接地址前缀。连接地址的前缀需满足以下规则：以小写字母开头，以小写字母或数字结尾。由小写字母、数字和中划线（-）中的至少两种组成。连接地址前缀应至少包含 8 个字符，连接地址总长度（前缀+后缀）不得超过 63个字符。
EipId string: EIP 的 ID，仅对 Public 地址有效。
EipLocked bool: 连接终端使用的 EIP 是否因欠费关停。取值：true：是。false：否。
InternetProtocol string: IP 协议版本。取值为 IPv4。
IpAddress string: IP 地址。
NetworkType string: 网络地址类型，取值为：Private：私网地址。Public：公网地址。
Port string: 端口。
SubnetId string: 子网 ID，仅对 Private 地址有效。

dnsVisibility Boolean: false：火山引擎私网解析（默认）。true：火山引擎私网以及公网解析。
domain String: 连接域名。
domainPrefix String: 连接地址前缀。连接地址的前缀需满足以下规则：以小写字母开头，以小写字母或数字结尾。由小写字母、数字和中划线（-）中的至少两种组成。连接地址前缀应至少包含 8 个字符，连接地址总长度（前缀+后缀）不得超过 63个字符。
eipId String: EIP 的 ID，仅对 Public 地址有效。
eipLocked Boolean: 连接终端使用的 EIP 是否因欠费关停。取值：true：是。false：否。
internetProtocol String: IP 协议版本。取值为 IPv4。
ipAddress String: IP 地址。
networkType String: 网络地址类型，取值为：Private：私网地址。Public：公网地址。
port String: 端口。
subnetId String: 子网 ID，仅对 Private 地址有效。

dnsVisibility boolean: false：火山引擎私网解析（默认）。true：火山引擎私网以及公网解析。
domain string: 连接域名。
domainPrefix string: 连接地址前缀。连接地址的前缀需满足以下规则：以小写字母开头，以小写字母或数字结尾。由小写字母、数字和中划线（-）中的至少两种组成。连接地址前缀应至少包含 8 个字符，连接地址总长度（前缀+后缀）不得超过 63个字符。
eipId string: EIP 的 ID，仅对 Public 地址有效。
eipLocked boolean: 连接终端使用的 EIP 是否因欠费关停。取值：true：是。false：否。
internetProtocol string: IP 协议版本。取值为 IPv4。
ipAddress string: IP 地址。
networkType string: 网络地址类型，取值为：Private：私网地址。Public：公网地址。
port string: 端口。
subnetId string: 子网 ID，仅对 Private 地址有效。

dns_visibility bool: false：火山引擎私网解析（默认）。true：火山引擎私网以及公网解析。
domain str: 连接域名。
domain_prefix str: 连接地址前缀。连接地址的前缀需满足以下规则：以小写字母开头，以小写字母或数字结尾。由小写字母、数字和中划线（-）中的至少两种组成。连接地址前缀应至少包含 8 个字符，连接地址总长度（前缀+后缀）不得超过 63个字符。
eip_id str: EIP 的 ID，仅对 Public 地址有效。
eip_locked bool: 连接终端使用的 EIP 是否因欠费关停。取值：true：是。false：否。
internet_protocol str: IP 协议版本。取值为 IPv4。
ip_address str: IP 地址。
network_type str: 网络地址类型，取值为：Private：私网地址。Public：公网地址。
port str: 端口。
subnet_id str: 子网 ID，仅对 Private 地址有效。

dnsVisibility Boolean: false：火山引擎私网解析（默认）。true：火山引擎私网以及公网解析。
domain String: 连接域名。
domainPrefix String: 连接地址前缀。连接地址的前缀需满足以下规则：以小写字母开头，以小写字母或数字结尾。由小写字母、数字和中划线（-）中的至少两种组成。连接地址前缀应至少包含 8 个字符，连接地址总长度（前缀+后缀）不得超过 63个字符。
eipId String: EIP 的 ID，仅对 Public 地址有效。
eipLocked Boolean: 连接终端使用的 EIP 是否因欠费关停。取值：true：是。false：否。
internetProtocol String: IP 协议版本。取值为 IPv4。
ipAddress String: IP 地址。
networkType String: 网络地址类型，取值为：Private：私网地址。Public：公网地址。
port String: 端口。
subnetId String: 子网 ID，仅对 Private 地址有效。

GetEndpointCustomRouteStrategy

KeywordRouteStrategies List<Byteplus.GetEndpointCustomRouteStrategyKeywordRouteStrategy>: 自定义路由策略列表。

KeywordRouteStrategies []GetEndpointCustomRouteStrategyKeywordRouteStrategy: 自定义路由策略列表。

keywordRouteStrategies List<GetEndpointCustomRouteStrategyKeywordRouteStrategy>: 自定义路由策略列表。

keywordRouteStrategies GetEndpointCustomRouteStrategyKeywordRouteStrategy[]: 自定义路由策略列表。

keyword_route_strategies Sequence[GetEndpointCustomRouteStrategyKeywordRouteStrategy]: 自定义路由策略列表。

keywordRouteStrategies List<Property Map>: 自定义路由策略列表。

GetEndpointCustomRouteStrategyKeywordRouteStrategy

NodeType string: SQL 转发规则的转发目标。取值：Primary：主节点。Secondary：备节点。ReadOnly：只读节点。说明如实例为双节点实例，可选择主节点或只读节点。如实例为多节点实例，可选择主节点或备节点。
SqlKeyword string: 转发规则的关键字。SQL 关键字的设置规则如下：单个规则最多可包含 20 个关键字。最大长度为 64 个字符，可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。

NodeType string: SQL 转发规则的转发目标。取值：Primary：主节点。Secondary：备节点。ReadOnly：只读节点。说明如实例为双节点实例，可选择主节点或只读节点。如实例为多节点实例，可选择主节点或备节点。
SqlKeyword string: 转发规则的关键字。SQL 关键字的设置规则如下：单个规则最多可包含 20 个关键字。最大长度为 64 个字符，可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。

nodeType String: SQL 转发规则的转发目标。取值：Primary：主节点。Secondary：备节点。ReadOnly：只读节点。说明如实例为双节点实例，可选择主节点或只读节点。如实例为多节点实例，可选择主节点或备节点。
sqlKeyword String: 转发规则的关键字。SQL 关键字的设置规则如下：单个规则最多可包含 20 个关键字。最大长度为 64 个字符，可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。

nodeType string: SQL 转发规则的转发目标。取值：Primary：主节点。Secondary：备节点。ReadOnly：只读节点。说明如实例为双节点实例，可选择主节点或只读节点。如实例为多节点实例，可选择主节点或备节点。
sqlKeyword string: 转发规则的关键字。SQL 关键字的设置规则如下：单个规则最多可包含 20 个关键字。最大长度为 64 个字符，可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。

node_type str: SQL 转发规则的转发目标。取值：Primary：主节点。Secondary：备节点。ReadOnly：只读节点。说明如实例为双节点实例，可选择主节点或只读节点。如实例为多节点实例，可选择主节点或备节点。
sql_keyword str: 转发规则的关键字。SQL 关键字的设置规则如下：单个规则最多可包含 20 个关键字。最大长度为 64 个字符，可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。

nodeType String: SQL 转发规则的转发目标。取值：Primary：主节点。Secondary：备节点。ReadOnly：只读节点。说明如实例为双节点实例，可选择主节点或只读节点。如实例为多节点实例，可选择主节点或备节点。
sqlKeyword String: 转发规则的关键字。SQL 关键字的设置规则如下：单个规则最多可包含 20 个关键字。最大长度为 64 个字符，可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。

GetEndpointReadOnlyNodeWeight

NodeId string: 只读节点需要传入 NodeId，主节点无需传入。
NodeType string: 节点类型。Primary：主节点。ReadOnly：只读节点。
Weight int: 节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

NodeId string: 只读节点需要传入 NodeId，主节点无需传入。
NodeType string: 节点类型。Primary：主节点。ReadOnly：只读节点。
Weight int: 节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

nodeId String: 只读节点需要传入 NodeId，主节点无需传入。
nodeType String: 节点类型。Primary：主节点。ReadOnly：只读节点。
weight Integer: 节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

nodeId string: 只读节点需要传入 NodeId，主节点无需传入。
nodeType string: 节点类型。Primary：主节点。ReadOnly：只读节点。
weight number: 节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

node_id str: 只读节点需要传入 NodeId，主节点无需传入。
node_type str: 节点类型。Primary：主节点。ReadOnly：只读节点。
weight int: 节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

nodeId String: 只读节点需要传入 NodeId，主节点无需传入。
nodeType String: 节点类型。Primary：主节点。ReadOnly：只读节点。
weight Number: 节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.rdsmysql.getEndpoint

On this page

On this page

Using getEndpoint

getEndpoint Result

Supporting Types

GetEndpointAddress

GetEndpointCustomRouteStrategy

GetEndpointCustomRouteStrategyKeywordRouteStrategy

GetEndpointReadOnlyNodeWeight

Package Details

On this page

On this page