bytepluscc.privatelink.getEndpointService

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 getEndpointService

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 getEndpointService(args: GetEndpointServiceArgs, opts?: InvokeOptions): Promise<GetEndpointServiceResult>
function getEndpointServiceOutput(args: GetEndpointServiceOutputArgs, opts?: InvokeOptions): Output<GetEndpointServiceResult>

def get_endpoint_service(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetEndpointServiceResult
def get_endpoint_service_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetEndpointServiceResult]

func LookupEndpointService(ctx *Context, args *LookupEndpointServiceArgs, opts ...InvokeOption) (*LookupEndpointServiceResult, error)
func LookupEndpointServiceOutput(ctx *Context, args *LookupEndpointServiceOutputArgs, opts ...InvokeOption) LookupEndpointServiceResultOutput

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

public static class GetEndpointService 
{
    public static Task<GetEndpointServiceResult> InvokeAsync(GetEndpointServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointServiceResult> Invoke(GetEndpointServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointServiceResult> getEndpointService(GetEndpointServiceArgs args, InvokeOptions options)
public static Output<GetEndpointServiceResult> getEndpointService(GetEndpointServiceArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:privatelink/getEndpointService:getEndpointService
  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.

getEndpointService Result

The following output properties are available:

AutoAcceptEnabled bool: 是否自动接受终端节点连接。true：终端节点服务自动接受终端节点连接。false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。
BillingType int: 终端节点服务的计费类型。0：不计费。3：按量计费。
BusinessStatus string: 终端节点服务是否被锁定。Normal：正常。FinancialLocked：被锁定。说明该参数返回为空时，表示终端节点服务未锁定。
CreateTime string: 终端节点服务的创建时间。
Description string: 终端节点服务的描述信息。
Id string: Uniquely identifies the resource.
IpAddressVersions List<string>: 终端节点服务的IP协议类型。返回值中仅包含ipv4时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。返回值中同时包含ipv4和ipv6时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。
Payer string: 私网连接的付费账号。Endpoint：终端节点账号。EndpointService：终端节点服务账号。
PrivateDnsEnabled bool: 终端节点服务是否启用私有DNS名称。false：未启用。true：已启用。
PrivateDnsName string: 终端节点服务的私有DNS名称。参数PrivateDNSEnabled返回值为false时，该参数返回空。
PrivateDnsNameConfiguration Byteplus.GetEndpointServicePrivateDnsNameConfiguration: 终端节点服务私有DNS名称的配置信息。说明PrivateDNSType为private时，不返回该参数。
PrivateDnsType string: 私有DNS名称的域名类型。public：公网。说明未开通自定义私网域名功能时，不返回该参数。
ProjectName string: 终端节点服务所属的项目名称。
Resources List<Byteplus.GetEndpointServiceResource>: 终端节点服务提供服务的资源。
ServiceDomain string: 终端节点服务的服务域名。
ServiceId string: 终端节点服务的ID。
ServiceName string: 终端节点服务的名称。
ServiceNameManaged string: 是否为托管终端节点服务。false：非托管终端节点服务。true：托管终端节点服务。说明终端节点服务所属账号未开通托管终端节点服务功能时，不返回该参数。
ServiceNameSuffix string: 终端节点服务的名称后缀。设置名称后缀后，系统会按照com.volces.privatelink.<地域ID>.<名称后缀>的格式生成终端节点服务的名称。说明该参数正在邀测中，如需使用不同名称后缀区分业务，请联系客户经理。
ServiceOwner string: 当前服务主体。
ServiceResourceType string: 服务资源的类型。CLB：负载均衡CLB。ALB：应用型负载均衡ALB。RDSMySQL：云数据库 MySQL版。
ServiceType string: 终端节点服务的类型。Interface：接口终端节点服务。
Status string: 终端节点服务的状态。Creating：创建中。Pending：配置修改中。Available：可用。Deleting：删除中。
Tags List<Byteplus.GetEndpointServiceTag>: 终端节点服务的标签信息。
UpdateTime string: 终端节点服务的最近操作时间。
WildcardDomainEnabled bool: 是否启用通配符域名。true：启用。false：未启用。
ZoneIds List<string>: 终端节点服务提供服务的可用区。说明参数ServiceResourceType返回值为RDSMySQL时，该参数返回空值。

AutoAcceptEnabled bool: 是否自动接受终端节点连接。true：终端节点服务自动接受终端节点连接。false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。
BillingType int: 终端节点服务的计费类型。0：不计费。3：按量计费。
BusinessStatus string: 终端节点服务是否被锁定。Normal：正常。FinancialLocked：被锁定。说明该参数返回为空时，表示终端节点服务未锁定。
CreateTime string: 终端节点服务的创建时间。
Description string: 终端节点服务的描述信息。
Id string: Uniquely identifies the resource.
IpAddressVersions []string: 终端节点服务的IP协议类型。返回值中仅包含ipv4时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。返回值中同时包含ipv4和ipv6时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。
Payer string: 私网连接的付费账号。Endpoint：终端节点账号。EndpointService：终端节点服务账号。
PrivateDnsEnabled bool: 终端节点服务是否启用私有DNS名称。false：未启用。true：已启用。
PrivateDnsName string: 终端节点服务的私有DNS名称。参数PrivateDNSEnabled返回值为false时，该参数返回空。
PrivateDnsNameConfiguration GetEndpointServicePrivateDnsNameConfiguration: 终端节点服务私有DNS名称的配置信息。说明PrivateDNSType为private时，不返回该参数。
PrivateDnsType string: 私有DNS名称的域名类型。public：公网。说明未开通自定义私网域名功能时，不返回该参数。
ProjectName string: 终端节点服务所属的项目名称。
Resources []GetEndpointServiceResource: 终端节点服务提供服务的资源。
ServiceDomain string: 终端节点服务的服务域名。
ServiceId string: 终端节点服务的ID。
ServiceName string: 终端节点服务的名称。
ServiceNameManaged string: 是否为托管终端节点服务。false：非托管终端节点服务。true：托管终端节点服务。说明终端节点服务所属账号未开通托管终端节点服务功能时，不返回该参数。
ServiceNameSuffix string: 终端节点服务的名称后缀。设置名称后缀后，系统会按照com.volces.privatelink.<地域ID>.<名称后缀>的格式生成终端节点服务的名称。说明该参数正在邀测中，如需使用不同名称后缀区分业务，请联系客户经理。
ServiceOwner string: 当前服务主体。
ServiceResourceType string: 服务资源的类型。CLB：负载均衡CLB。ALB：应用型负载均衡ALB。RDSMySQL：云数据库 MySQL版。
ServiceType string: 终端节点服务的类型。Interface：接口终端节点服务。
Status string: 终端节点服务的状态。Creating：创建中。Pending：配置修改中。Available：可用。Deleting：删除中。
Tags []GetEndpointServiceTag: 终端节点服务的标签信息。
UpdateTime string: 终端节点服务的最近操作时间。
WildcardDomainEnabled bool: 是否启用通配符域名。true：启用。false：未启用。
ZoneIds []string: 终端节点服务提供服务的可用区。说明参数ServiceResourceType返回值为RDSMySQL时，该参数返回空值。

autoAcceptEnabled Boolean: 是否自动接受终端节点连接。true：终端节点服务自动接受终端节点连接。false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。
billingType Integer: 终端节点服务的计费类型。0：不计费。3：按量计费。
businessStatus String: 终端节点服务是否被锁定。Normal：正常。FinancialLocked：被锁定。说明该参数返回为空时，表示终端节点服务未锁定。
createTime String: 终端节点服务的创建时间。
description String: 终端节点服务的描述信息。
id String: Uniquely identifies the resource.
ipAddressVersions List<String>: 终端节点服务的IP协议类型。返回值中仅包含ipv4时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。返回值中同时包含ipv4和ipv6时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。
payer String: 私网连接的付费账号。Endpoint：终端节点账号。EndpointService：终端节点服务账号。
privateDnsEnabled Boolean: 终端节点服务是否启用私有DNS名称。false：未启用。true：已启用。
privateDnsName String: 终端节点服务的私有DNS名称。参数PrivateDNSEnabled返回值为false时，该参数返回空。
privateDnsNameConfiguration GetEndpointServicePrivateDnsNameConfiguration: 终端节点服务私有DNS名称的配置信息。说明PrivateDNSType为private时，不返回该参数。
privateDnsType String: 私有DNS名称的域名类型。public：公网。说明未开通自定义私网域名功能时，不返回该参数。
projectName String: 终端节点服务所属的项目名称。
resources List<GetEndpointServiceResource>: 终端节点服务提供服务的资源。
serviceDomain String: 终端节点服务的服务域名。
serviceId String: 终端节点服务的ID。
serviceName String: 终端节点服务的名称。
serviceNameManaged String: 是否为托管终端节点服务。false：非托管终端节点服务。true：托管终端节点服务。说明终端节点服务所属账号未开通托管终端节点服务功能时，不返回该参数。
serviceNameSuffix String: 终端节点服务的名称后缀。设置名称后缀后，系统会按照com.volces.privatelink.<地域ID>.<名称后缀>的格式生成终端节点服务的名称。说明该参数正在邀测中，如需使用不同名称后缀区分业务，请联系客户经理。
serviceOwner String: 当前服务主体。
serviceResourceType String: 服务资源的类型。CLB：负载均衡CLB。ALB：应用型负载均衡ALB。RDSMySQL：云数据库 MySQL版。
serviceType String: 终端节点服务的类型。Interface：接口终端节点服务。
status String: 终端节点服务的状态。Creating：创建中。Pending：配置修改中。Available：可用。Deleting：删除中。
tags List<GetEndpointServiceTag>: 终端节点服务的标签信息。
updateTime String: 终端节点服务的最近操作时间。
wildcardDomainEnabled Boolean: 是否启用通配符域名。true：启用。false：未启用。
zoneIds List<String>: 终端节点服务提供服务的可用区。说明参数ServiceResourceType返回值为RDSMySQL时，该参数返回空值。

autoAcceptEnabled boolean: 是否自动接受终端节点连接。true：终端节点服务自动接受终端节点连接。false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。
billingType number: 终端节点服务的计费类型。0：不计费。3：按量计费。
businessStatus string: 终端节点服务是否被锁定。Normal：正常。FinancialLocked：被锁定。说明该参数返回为空时，表示终端节点服务未锁定。
createTime string: 终端节点服务的创建时间。
description string: 终端节点服务的描述信息。
id string: Uniquely identifies the resource.
ipAddressVersions string[]: 终端节点服务的IP协议类型。返回值中仅包含ipv4时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。返回值中同时包含ipv4和ipv6时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。
payer string: 私网连接的付费账号。Endpoint：终端节点账号。EndpointService：终端节点服务账号。
privateDnsEnabled boolean: 终端节点服务是否启用私有DNS名称。false：未启用。true：已启用。
privateDnsName string: 终端节点服务的私有DNS名称。参数PrivateDNSEnabled返回值为false时，该参数返回空。
privateDnsNameConfiguration GetEndpointServicePrivateDnsNameConfiguration: 终端节点服务私有DNS名称的配置信息。说明PrivateDNSType为private时，不返回该参数。
privateDnsType string: 私有DNS名称的域名类型。public：公网。说明未开通自定义私网域名功能时，不返回该参数。
projectName string: 终端节点服务所属的项目名称。
resources GetEndpointServiceResource[]: 终端节点服务提供服务的资源。
serviceDomain string: 终端节点服务的服务域名。
serviceId string: 终端节点服务的ID。
serviceName string: 终端节点服务的名称。
serviceNameManaged string: 是否为托管终端节点服务。false：非托管终端节点服务。true：托管终端节点服务。说明终端节点服务所属账号未开通托管终端节点服务功能时，不返回该参数。
serviceNameSuffix string: 终端节点服务的名称后缀。设置名称后缀后，系统会按照com.volces.privatelink.<地域ID>.<名称后缀>的格式生成终端节点服务的名称。说明该参数正在邀测中，如需使用不同名称后缀区分业务，请联系客户经理。
serviceOwner string: 当前服务主体。
serviceResourceType string: 服务资源的类型。CLB：负载均衡CLB。ALB：应用型负载均衡ALB。RDSMySQL：云数据库 MySQL版。
serviceType string: 终端节点服务的类型。Interface：接口终端节点服务。
status string: 终端节点服务的状态。Creating：创建中。Pending：配置修改中。Available：可用。Deleting：删除中。
tags GetEndpointServiceTag[]: 终端节点服务的标签信息。
updateTime string: 终端节点服务的最近操作时间。
wildcardDomainEnabled boolean: 是否启用通配符域名。true：启用。false：未启用。
zoneIds string[]: 终端节点服务提供服务的可用区。说明参数ServiceResourceType返回值为RDSMySQL时，该参数返回空值。

auto_accept_enabled bool: 是否自动接受终端节点连接。true：终端节点服务自动接受终端节点连接。false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。
billing_type int: 终端节点服务的计费类型。0：不计费。3：按量计费。
business_status str: 终端节点服务是否被锁定。Normal：正常。FinancialLocked：被锁定。说明该参数返回为空时，表示终端节点服务未锁定。
create_time str: 终端节点服务的创建时间。
description str: 终端节点服务的描述信息。
id str: Uniquely identifies the resource.
ip_address_versions Sequence[str]: 终端节点服务的IP协议类型。返回值中仅包含ipv4时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。返回值中同时包含ipv4和ipv6时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。
payer str: 私网连接的付费账号。Endpoint：终端节点账号。EndpointService：终端节点服务账号。
private_dns_enabled bool: 终端节点服务是否启用私有DNS名称。false：未启用。true：已启用。
private_dns_name str: 终端节点服务的私有DNS名称。参数PrivateDNSEnabled返回值为false时，该参数返回空。
private_dns_name_configuration GetEndpointServicePrivateDnsNameConfiguration: 终端节点服务私有DNS名称的配置信息。说明PrivateDNSType为private时，不返回该参数。
private_dns_type str: 私有DNS名称的域名类型。public：公网。说明未开通自定义私网域名功能时，不返回该参数。
project_name str: 终端节点服务所属的项目名称。
resources Sequence[GetEndpointServiceResource]: 终端节点服务提供服务的资源。
service_domain str: 终端节点服务的服务域名。
service_id str: 终端节点服务的ID。
service_name str: 终端节点服务的名称。
service_name_managed str: 是否为托管终端节点服务。false：非托管终端节点服务。true：托管终端节点服务。说明终端节点服务所属账号未开通托管终端节点服务功能时，不返回该参数。
service_name_suffix str: 终端节点服务的名称后缀。设置名称后缀后，系统会按照com.volces.privatelink.<地域ID>.<名称后缀>的格式生成终端节点服务的名称。说明该参数正在邀测中，如需使用不同名称后缀区分业务，请联系客户经理。
service_owner str: 当前服务主体。
service_resource_type str: 服务资源的类型。CLB：负载均衡CLB。ALB：应用型负载均衡ALB。RDSMySQL：云数据库 MySQL版。
service_type str: 终端节点服务的类型。Interface：接口终端节点服务。
status str: 终端节点服务的状态。Creating：创建中。Pending：配置修改中。Available：可用。Deleting：删除中。
tags Sequence[GetEndpointServiceTag]: 终端节点服务的标签信息。
update_time str: 终端节点服务的最近操作时间。
wildcard_domain_enabled bool: 是否启用通配符域名。true：启用。false：未启用。
zone_ids Sequence[str]: 终端节点服务提供服务的可用区。说明参数ServiceResourceType返回值为RDSMySQL时，该参数返回空值。

autoAcceptEnabled Boolean: 是否自动接受终端节点连接。true：终端节点服务自动接受终端节点连接。false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。
billingType Number: 终端节点服务的计费类型。0：不计费。3：按量计费。
businessStatus String: 终端节点服务是否被锁定。Normal：正常。FinancialLocked：被锁定。说明该参数返回为空时，表示终端节点服务未锁定。
createTime String: 终端节点服务的创建时间。
description String: 终端节点服务的描述信息。
id String: Uniquely identifies the resource.
ipAddressVersions List<String>: 终端节点服务的IP协议类型。返回值中仅包含ipv4时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。返回值中同时包含ipv4和ipv6时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。
payer String: 私网连接的付费账号。Endpoint：终端节点账号。EndpointService：终端节点服务账号。
privateDnsEnabled Boolean: 终端节点服务是否启用私有DNS名称。false：未启用。true：已启用。
privateDnsName String: 终端节点服务的私有DNS名称。参数PrivateDNSEnabled返回值为false时，该参数返回空。
privateDnsNameConfiguration Property Map: 终端节点服务私有DNS名称的配置信息。说明PrivateDNSType为private时，不返回该参数。
privateDnsType String: 私有DNS名称的域名类型。public：公网。说明未开通自定义私网域名功能时，不返回该参数。
projectName String: 终端节点服务所属的项目名称。
resources List<Property Map>: 终端节点服务提供服务的资源。
serviceDomain String: 终端节点服务的服务域名。
serviceId String: 终端节点服务的ID。
serviceName String: 终端节点服务的名称。
serviceNameManaged String: 是否为托管终端节点服务。false：非托管终端节点服务。true：托管终端节点服务。说明终端节点服务所属账号未开通托管终端节点服务功能时，不返回该参数。
serviceNameSuffix String: 终端节点服务的名称后缀。设置名称后缀后，系统会按照com.volces.privatelink.<地域ID>.<名称后缀>的格式生成终端节点服务的名称。说明该参数正在邀测中，如需使用不同名称后缀区分业务，请联系客户经理。
serviceOwner String: 当前服务主体。
serviceResourceType String: 服务资源的类型。CLB：负载均衡CLB。ALB：应用型负载均衡ALB。RDSMySQL：云数据库 MySQL版。
serviceType String: 终端节点服务的类型。Interface：接口终端节点服务。
status String: 终端节点服务的状态。Creating：创建中。Pending：配置修改中。Available：可用。Deleting：删除中。
tags List<Property Map>: 终端节点服务的标签信息。
updateTime String: 终端节点服务的最近操作时间。
wildcardDomainEnabled Boolean: 是否启用通配符域名。true：启用。false：未启用。
zoneIds List<String>: 终端节点服务提供服务的可用区。说明参数ServiceResourceType返回值为RDSMySQL时，该参数返回空值。

Supporting Types

GetEndpointServicePrivateDnsNameConfiguration

Name string: 域验证名称。
Status string: 域验证状态。PendingVerification：待验证Verifying：验证中Verified：验证通过Failed：验证失败
Type string: 域验证类型。TXT：TXT记录。
Value string: 域验证值。

Name string: 域验证名称。
Status string: 域验证状态。PendingVerification：待验证Verifying：验证中Verified：验证通过Failed：验证失败
Type string: 域验证类型。TXT：TXT记录。
Value string: 域验证值。

name String: 域验证名称。
status String: 域验证状态。PendingVerification：待验证Verifying：验证中Verified：验证通过Failed：验证失败
type String: 域验证类型。TXT：TXT记录。
value String: 域验证值。

name string: 域验证名称。
status string: 域验证状态。PendingVerification：待验证Verifying：验证中Verified：验证通过Failed：验证失败
type string: 域验证类型。TXT：TXT记录。
value string: 域验证值。

name str: 域验证名称。
status str: 域验证状态。PendingVerification：待验证Verifying：验证中Verified：验证通过Failed：验证失败
type str: 域验证类型。TXT：TXT记录。
value str: 域验证值。

name String: 域验证名称。
status String: 域验证状态。PendingVerification：待验证Verifying：验证中Verified：验证通过Failed：验证失败
type String: 域验证类型。TXT：TXT记录。
value String: 域验证值。

GetEndpointServiceResource

InstanceId string: 终端节点服务ID。
ResourceId string: 待添加到终端节点服务中的服务资源ID。
ZoneIds List<string>: 负载均衡提供服务的可用区。

InstanceId string: 终端节点服务ID。
ResourceId string: 待添加到终端节点服务中的服务资源ID。
ZoneIds []string: 负载均衡提供服务的可用区。

instanceId String: 终端节点服务ID。
resourceId String: 待添加到终端节点服务中的服务资源ID。
zoneIds List<String>: 负载均衡提供服务的可用区。

instanceId string: 终端节点服务ID。
resourceId string: 待添加到终端节点服务中的服务资源ID。
zoneIds string[]: 负载均衡提供服务的可用区。

instance_id str: 终端节点服务ID。
resource_id str: 待添加到终端节点服务中的服务资源ID。
zone_ids Sequence[str]: 负载均衡提供服务的可用区。

instanceId String: 终端节点服务ID。
resourceId String: 待添加到终端节点服务中的服务资源ID。
zoneIds List<String>: 负载均衡提供服务的可用区。

GetEndpointServiceTag

Key string: 终端节点服务标签的标签键。
Value string: 终端节点服务标签的标签值。

Key string: 终端节点服务标签的标签键。
Value string: 终端节点服务标签的标签值。

key String: 终端节点服务标签的标签键。
value String: 终端节点服务标签的标签值。

key string: 终端节点服务标签的标签键。
value string: 终端节点服务标签的标签值。

key str: 终端节点服务标签的标签键。
value str: 终端节点服务标签的标签值。

key String: 终端节点服务标签的标签键。
value String: 终端节点服务标签的标签值。

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.privatelink.getEndpointService

On this page

On this page

Using getEndpointService

getEndpointService Result

Supporting Types

GetEndpointServicePrivateDnsNameConfiguration

GetEndpointServiceResource

GetEndpointServiceTag

Package Details

On this page

On this page