bytepluscc.rdspostgresql.getDbEndpoint

bytepluscc v0.0.21, Apr 2 26

Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getDbEndpoint

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 getDbEndpoint(args: GetDbEndpointArgs, opts?: InvokeOptions): Promise<GetDbEndpointResult>
function getDbEndpointOutput(args: GetDbEndpointOutputArgs, opts?: InvokeOptions): Output<GetDbEndpointResult>

def get_db_endpoint(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDbEndpointResult
def get_db_endpoint_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDbEndpointResult]

func LookupDbEndpoint(ctx *Context, args *LookupDbEndpointArgs, opts ...InvokeOption) (*LookupDbEndpointResult, error)
func LookupDbEndpointOutput(ctx *Context, args *LookupDbEndpointOutputArgs, opts ...InvokeOption) LookupDbEndpointResultOutput

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

public static class GetDbEndpoint 
{
    public static Task<GetDbEndpointResult> InvokeAsync(GetDbEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetDbEndpointResult> Invoke(GetDbEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDbEndpointResult> getDbEndpoint(GetDbEndpointArgs args, InvokeOptions options)
public static Output<GetDbEndpointResult> getDbEndpoint(GetDbEndpointArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:rdspostgresql/getDbEndpoint:getDbEndpoint
  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.

getDbEndpoint Result

The following output properties are available:

Addresses List<Byteplus.GetDbEndpointAddress>: Address list.
AutoAddNewNodes string: When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
Description string: Address description
EnableReadOnly string: Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
EnableReadWriteSplitting string: Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
EndpointId string: Instance connection endpoint ID.
EndpointName string: Instance connection endpoint name.
EndpointType string: Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID.
Nodes string: List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
ReadOnlyNodeDistributionType string: Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
ReadOnlyNodeMaxDelayTime int: Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
ReadOnlyNodeWeights List<Byteplus.GetDbEndpointReadOnlyNodeWeight>: List of nodes configured for the connection endpoint and their corresponding read-only weights.
ReadWriteMode string: Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
ReadWriteProxyConnection int: After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
WriteNodeHaltWriting bool: Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.

Addresses []GetDbEndpointAddress: Address list.
AutoAddNewNodes string: When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
Description string: Address description
EnableReadOnly string: Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
EnableReadWriteSplitting string: Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
EndpointId string: Instance connection endpoint ID.
EndpointName string: Instance connection endpoint name.
EndpointType string: Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID.
Nodes string: List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
ReadOnlyNodeDistributionType string: Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
ReadOnlyNodeMaxDelayTime int: Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
ReadOnlyNodeWeights []GetDbEndpointReadOnlyNodeWeight: List of nodes configured for the connection endpoint and their corresponding read-only weights.
ReadWriteMode string: Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
ReadWriteProxyConnection int: After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
WriteNodeHaltWriting bool: Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.

addresses List<GetDbEndpointAddress>: Address list.
autoAddNewNodes String: When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
description String: Address description
enableReadOnly String: Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
enableReadWriteSplitting String: Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
endpointId String: Instance connection endpoint ID.
endpointName String: Instance connection endpoint name.
endpointType String: Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
id String: Uniquely identifies the resource.
instanceId String: Instance ID.
nodes String: List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
readOnlyNodeDistributionType String: Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
readOnlyNodeMaxDelayTime Integer: Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
readOnlyNodeWeights List<GetDbEndpointReadOnlyNodeWeight>: List of nodes configured for the connection endpoint and their corresponding read-only weights.
readWriteMode String: Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
readWriteProxyConnection Integer: After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
writeNodeHaltWriting Boolean: Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.

addresses GetDbEndpointAddress[]: Address list.
autoAddNewNodes string: When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
description string: Address description
enableReadOnly string: Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
enableReadWriteSplitting string: Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
endpointId string: Instance connection endpoint ID.
endpointName string: Instance connection endpoint name.
endpointType string: Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
id string: Uniquely identifies the resource.
instanceId string: Instance ID.
nodes string: List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
readOnlyNodeDistributionType string: Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
readOnlyNodeMaxDelayTime number: Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
readOnlyNodeWeights GetDbEndpointReadOnlyNodeWeight[]: List of nodes configured for the connection endpoint and their corresponding read-only weights.
readWriteMode string: Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
readWriteProxyConnection number: After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
writeNodeHaltWriting boolean: Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.

addresses Sequence[GetDbEndpointAddress]: Address list.
auto_add_new_nodes str: When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
description str: Address description
enable_read_only str: Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
enable_read_write_splitting str: Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
endpoint_id str: Instance connection endpoint ID.
endpoint_name str: Instance connection endpoint name.
endpoint_type str: Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
id str: Uniquely identifies the resource.
instance_id str: Instance ID.
nodes str: List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
read_only_node_distribution_type str: Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
read_only_node_max_delay_time int: Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
read_only_node_weights Sequence[GetDbEndpointReadOnlyNodeWeight]: List of nodes configured for the connection endpoint and their corresponding read-only weights.
read_write_mode str: Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
read_write_proxy_connection int: After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
write_node_halt_writing bool: Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.

addresses List<Property Map>: Address list.
autoAddNewNodes String: When the endpoint type is read/write or read-only, you can configure whether new nodes are automatically added. Values: Enable: Automatically add. Disable: Do not automatically add (default).
description String: Address description
enableReadOnly String: Whether global read-only is enabled. Enable: Enabled. Disable: Not enabled.
enableReadWriteSplitting String: Whether read/write splitting is enabled. Values: Enable: Enabled. Disable: Not enabled.
endpointId String: Instance connection endpoint ID.
endpointName String: Instance connection endpoint name.
endpointType String: Endpoint type: Cluster: default endpoint (created by default). Custom: custom endpoint.
id String: Uniquely identifies the resource.
instanceId String: Instance ID.
nodes String: List of nodes configured for the connection endpoint. Note: Required when EndpointType is Custom. The primary node does not require a node ID; use the string 'Primary'.
readOnlyNodeDistributionType String: Read-only weight allocation mode. Values: Default: standard weight allocation (default). Custom: custom weight allocation.
readOnlyNodeMaxDelayTime Number: Maximum latency threshold for read-only nodes. When the latency of a read-only node exceeds this value, read traffic will not be sent to that node. Unit: seconds. Range: 0~3600. Default: 30. Note: This parameter can be set for default endpoints with read/write splitting enabled.
readOnlyNodeWeights List<Property Map>: List of nodes configured for the connection endpoint and their corresponding read-only weights.
readWriteMode String: Read/write mode: ReadWrite: read/write. ReadOnly: read-only.
readWriteProxyConnection Number: After enabling read/write splitting for the endpoint, set the number of proxy connections for the endpoint. The minimum value for proxy connections is 20. The maximum value depends on the specifications of the primary node; different specifications support different maximum proxy connections. For details, see product specifications.
writeNodeHaltWriting Boolean: Whether the endpoint sends write requests to the write node (currently only the primary node is the write node). Values: true: Yes (default). false: No.

Supporting Types

GetDbEndpointAddress

CrossRegionDomain string: Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
DnsVisibility bool: Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
Domain string: Connection domain name
DomainPrefix string: New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
DomainVisibilitySetting string: Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
EipId string: EIP ID, valid only for Public addresses.
IpAddress string: IP address
NetworkType string: Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
Port string: Port number.
SubnetId string: Subnet ID

CrossRegionDomain string: Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
DnsVisibility bool: Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
Domain string: Connection domain name
DomainPrefix string: New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
DomainVisibilitySetting string: Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
EipId string: EIP ID, valid only for Public addresses.
IpAddress string: IP address
NetworkType string: Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
Port string: Port number.
SubnetId string: Subnet ID

crossRegionDomain String: Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
dnsVisibility Boolean: Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
domain String: Connection domain name
domainPrefix String: New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
domainVisibilitySetting String: Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
eipId String: EIP ID, valid only for Public addresses.
ipAddress String: IP address
networkType String: Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
port String: Port number.
subnetId String: Subnet ID

crossRegionDomain string: Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
dnsVisibility boolean: Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
domain string: Connection domain name
domainPrefix string: New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
domainVisibilitySetting string: Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
eipId string: EIP ID, valid only for Public addresses.
ipAddress string: IP address
networkType string: Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
port string: Port number.
subnetId string: Subnet ID

cross_region_domain str: Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
dns_visibility bool: Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
domain str: Connection domain name
domain_prefix str: New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
domain_visibility_setting str: Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
eip_id str: EIP ID, valid only for Public addresses.
ip_address str: IP address
network_type str: Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
port str: Port number.
subnet_id str: Subnet ID

crossRegionDomain String: Private network address accessible across regions. Note: If this address is unavailable, this field will not be returned.
dnsVisibility Boolean: Whether public network resolution is enabled. Values: false: Default, private network resolution. true: Both private and public network resolution.
domain String: Connection domain name
domainPrefix String: New access address prefix. The access address prefix must meet the following rules: consists of lowercase letters, numbers, and hyphens (-). Must contain at least 8 characters. The total length (including suffix) must not exceed 63 characters. Must start with a lowercase letter and end with a lowercase letter or number.
domainVisibilitySetting String: Type of private network address. Values: LocalDomain: Local region domain name. CrossRegionDomain: Domain name accessible across regions.
eipId String: EIP ID, valid only for Public addresses.
ipAddress String: IP address
networkType String: Network address type. Values: Private: private network connection address. Public: public network connection address. Inner: public service zone address.
port String: Port number.
subnetId String: Subnet ID

GetDbEndpointReadOnlyNodeWeight

NodeId string: Read-only nodes require the NodeId to be provided.
NodeType string: Node type. Values: Primary: primary node. ReadOnly: read-only node.
Weight int: Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.

NodeId string: Read-only nodes require the NodeId to be provided.
NodeType string: Node type. Values: Primary: primary node. ReadOnly: read-only node.
Weight int: Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.

nodeId String: Read-only nodes require the NodeId to be provided.
nodeType String: Node type. Values: Primary: primary node. ReadOnly: read-only node.
weight Integer: Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.

nodeId string: Read-only nodes require the NodeId to be provided.
nodeType string: Node type. Values: Primary: primary node. ReadOnly: read-only node.
weight number: Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.

node_id str: Read-only nodes require the NodeId to be provided.
node_type str: Node type. Values: Primary: primary node. ReadOnly: read-only node.
weight int: Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.

nodeId String: Read-only nodes require the NodeId to be provided.
nodeType String: Node type. Values: Primary: primary node. ReadOnly: read-only node.
weight Number: Read weight of the node, increases in increments of 100, maximum value is 40000. Note: Weights cannot all be set to 0.