volcenginecc.rdspostgresql.getDbEndpoint

volcenginecc v0.0.24, Mar 9 26

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

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: volcenginecc: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<Volcengine.GetDbEndpointAddress>: 地址列表。
AutoAddNewNodes string: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
Description string: 地址描述。
EnableReadOnly string: 是否已开启全局只读。Enable：开启。Disable：未开启。
EnableReadWriteSplitting string: 是否已开启读写分离，取值：Enable：开启。Disable：未开启。
EndpointId string: 实例连接终端 ID。
EndpointName string: 实例连接终端名称。
EndpointType string: 终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
Id string: Uniquely identifies the resource.
InstanceId string: 实例 ID。
Nodes string: 连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
ReadOnlyNodeDistributionType string: 只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
ReadOnlyNodeMaxDelayTime int: 只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
ReadOnlyNodeWeights List<Volcengine.GetDbEndpointReadOnlyNodeWeight>: 连接终端配置的节点列表及对应的只读权重。
ReadWriteMode string: 读写模式：ReadWrite：读写。ReadOnly：只读。
ReadWriteProxyConnection int: 终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
WriteNodeHaltWriting bool: 终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

Addresses []GetDbEndpointAddress: 地址列表。
AutoAddNewNodes string: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
Description string: 地址描述。
EnableReadOnly string: 是否已开启全局只读。Enable：开启。Disable：未开启。
EnableReadWriteSplitting string: 是否已开启读写分离，取值：Enable：开启。Disable：未开启。
EndpointId string: 实例连接终端 ID。
EndpointName string: 实例连接终端名称。
EndpointType string: 终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
Id string: Uniquely identifies the resource.
InstanceId string: 实例 ID。
Nodes string: 连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
ReadOnlyNodeDistributionType string: 只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
ReadOnlyNodeMaxDelayTime int: 只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
ReadOnlyNodeWeights []GetDbEndpointReadOnlyNodeWeight: 连接终端配置的节点列表及对应的只读权重。
ReadWriteMode string: 读写模式：ReadWrite：读写。ReadOnly：只读。
ReadWriteProxyConnection int: 终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
WriteNodeHaltWriting bool: 终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

addresses List<GetDbEndpointAddress>: 地址列表。
autoAddNewNodes String: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
description String: 地址描述。
enableReadOnly String: 是否已开启全局只读。Enable：开启。Disable：未开启。
enableReadWriteSplitting String: 是否已开启读写分离，取值：Enable：开启。Disable：未开启。
endpointId String: 实例连接终端 ID。
endpointName String: 实例连接终端名称。
endpointType String: 终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
id String: Uniquely identifies the resource.
instanceId String: 实例 ID。
nodes String: 连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
readOnlyNodeDistributionType String: 只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
readOnlyNodeMaxDelayTime Integer: 只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
readOnlyNodeWeights List<GetDbEndpointReadOnlyNodeWeight>: 连接终端配置的节点列表及对应的只读权重。
readWriteMode String: 读写模式：ReadWrite：读写。ReadOnly：只读。
readWriteProxyConnection Integer: 终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
writeNodeHaltWriting Boolean: 终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

addresses GetDbEndpointAddress[]: 地址列表。
autoAddNewNodes string: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
description string: 地址描述。
enableReadOnly string: 是否已开启全局只读。Enable：开启。Disable：未开启。
enableReadWriteSplitting string: 是否已开启读写分离，取值：Enable：开启。Disable：未开启。
endpointId string: 实例连接终端 ID。
endpointName string: 实例连接终端名称。
endpointType string: 终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
id string: Uniquely identifies the resource.
instanceId string: 实例 ID。
nodes string: 连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
readOnlyNodeDistributionType string: 只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
readOnlyNodeMaxDelayTime number: 只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
readOnlyNodeWeights GetDbEndpointReadOnlyNodeWeight[]: 连接终端配置的节点列表及对应的只读权重。
readWriteMode string: 读写模式：ReadWrite：读写。ReadOnly：只读。
readWriteProxyConnection number: 终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
writeNodeHaltWriting boolean: 终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

addresses Sequence[GetDbEndpointAddress]: 地址列表。
auto_add_new_nodes str: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
description str: 地址描述。
enable_read_only str: 是否已开启全局只读。Enable：开启。Disable：未开启。
enable_read_write_splitting str: 是否已开启读写分离，取值：Enable：开启。Disable：未开启。
endpoint_id str: 实例连接终端 ID。
endpoint_name str: 实例连接终端名称。
endpoint_type str: 终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
id str: Uniquely identifies the resource.
instance_id str: 实例 ID。
nodes str: 连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
read_only_node_distribution_type str: 只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
read_only_node_max_delay_time int: 只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
read_only_node_weights Sequence[GetDbEndpointReadOnlyNodeWeight]: 连接终端配置的节点列表及对应的只读权重。
read_write_mode str: 读写模式：ReadWrite：读写。ReadOnly：只读。
read_write_proxy_connection int: 终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
write_node_halt_writing bool: 终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

addresses List<Property Map>: 地址列表。
autoAddNewNodes String: 当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：Enable：自动加入。Disable：不自动加入（默认）。
description String: 地址描述。
enableReadOnly String: 是否已开启全局只读。Enable：开启。Disable：未开启。
enableReadWriteSplitting String: 是否已开启读写分离，取值：Enable：开启。Disable：未开启。
endpointId String: 实例连接终端 ID。
endpointName String: 实例连接终端名称。
endpointType String: 终端类型：Cluster：默认终端（默认创建）。Custom：自定义终端。
id String: Uniquely identifies the resource.
instanceId String: 实例 ID。
nodes String: 连接终端配置的节点列表。说明当 EndpointType 为 Custom 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。
readOnlyNodeDistributionType String: 只读权重分配模式。取值：Default：标准权重分配（默认值）。Custom：自定义权重分配。
readOnlyNodeMaxDelayTime Number: 只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
readOnlyNodeWeights List<Property Map>: 连接终端配置的节点列表及对应的只读权重。
readWriteMode String: 读写模式：ReadWrite：读写。ReadOnly：只读。
readWriteProxyConnection Number: 终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
writeNodeHaltWriting Boolean: 终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值：true：是。默认值。false：否。

Supporting Types

GetDbEndpointAddress

CrossRegionDomain string: 可跨地域访问的私网地址。说明无此地址时则不返回该字段。
DnsVisibility bool: 是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
Domain string: 连接域名。
DomainPrefix string: 新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
DomainVisibilitySetting string: 私网地址类型。取值：LocalDomain：本地域域名。CrossRegionDomain：可跨地域访问域名。
EipId string: EIP 的 ID，仅对 Public 地址有效。
IpAddress string: IP 地址。
NetworkType string: 网络地址类型，取值为：Private：私网连接地址。Public：公网连接地址。Inner：公共服务区地址。
Port string: 端口号。
SubnetId string: 子网 ID。

CrossRegionDomain string: 可跨地域访问的私网地址。说明无此地址时则不返回该字段。
DnsVisibility bool: 是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
Domain string: 连接域名。
DomainPrefix string: 新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
DomainVisibilitySetting string: 私网地址类型。取值：LocalDomain：本地域域名。CrossRegionDomain：可跨地域访问域名。
EipId string: EIP 的 ID，仅对 Public 地址有效。
IpAddress string: IP 地址。
NetworkType string: 网络地址类型，取值为：Private：私网连接地址。Public：公网连接地址。Inner：公共服务区地址。
Port string: 端口号。
SubnetId string: 子网 ID。

crossRegionDomain String: 可跨地域访问的私网地址。说明无此地址时则不返回该字段。
dnsVisibility Boolean: 是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
domain String: 连接域名。
domainPrefix String: 新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
domainVisibilitySetting String: 私网地址类型。取值：LocalDomain：本地域域名。CrossRegionDomain：可跨地域访问域名。
eipId String: EIP 的 ID，仅对 Public 地址有效。
ipAddress String: IP 地址。
networkType String: 网络地址类型，取值为：Private：私网连接地址。Public：公网连接地址。Inner：公共服务区地址。
port String: 端口号。
subnetId String: 子网 ID。

crossRegionDomain string: 可跨地域访问的私网地址。说明无此地址时则不返回该字段。
dnsVisibility boolean: 是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
domain string: 连接域名。
domainPrefix string: 新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
domainVisibilitySetting string: 私网地址类型。取值：LocalDomain：本地域域名。CrossRegionDomain：可跨地域访问域名。
eipId string: EIP 的 ID，仅对 Public 地址有效。
ipAddress string: IP 地址。
networkType string: 网络地址类型，取值为：Private：私网连接地址。Public：公网连接地址。Inner：公共服务区地址。
port string: 端口号。
subnetId string: 子网 ID。

cross_region_domain str: 可跨地域访问的私网地址。说明无此地址时则不返回该字段。
dns_visibility bool: 是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
domain str: 连接域名。
domain_prefix str: 新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
domain_visibility_setting str: 私网地址类型。取值：LocalDomain：本地域域名。CrossRegionDomain：可跨地域访问域名。
eip_id str: EIP 的 ID，仅对 Public 地址有效。
ip_address str: IP 地址。
network_type str: 网络地址类型，取值为：Private：私网连接地址。Public：公网连接地址。Inner：公共服务区地址。
port str: 端口号。
subnet_id str: 子网 ID。

crossRegionDomain String: 可跨地域访问的私网地址。说明无此地址时则不返回该字段。
dnsVisibility Boolean: 是否开启公网解析。取值为：false：默认值，私网解析。true：私网以及公网解析。
domain String: 连接域名。
domainPrefix String: 新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
domainVisibilitySetting String: 私网地址类型。取值：LocalDomain：本地域域名。CrossRegionDomain：可跨地域访问域名。
eipId String: EIP 的 ID，仅对 Public 地址有效。
ipAddress String: IP 地址。
networkType String: 网络地址类型，取值为：Private：私网连接地址。Public：公网连接地址。Inner：公共服务区地址。
port String: 端口号。
subnetId String: 子网 ID。

GetDbEndpointReadOnlyNodeWeight

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

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

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

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

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

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

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.rdspostgresql.getDbEndpoint

On this page

On this page

Using getDbEndpoint

getDbEndpoint Result

Supporting Types

GetDbEndpointAddress

GetDbEndpointReadOnlyNodeWeight

Package Details

On this page

On this page