volcenginecc v0.0.3, Oct 30 25

volcenginecc v0.0.3 published on Thursday, Oct 30, 2025 by Volcengine

volcenginecc.alb.getServerGroup

volcenginecc v0.0.3 published on Thursday, Oct 30, 2025 by Volcengine

Using getServerGroup

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 getServerGroup(args: GetServerGroupArgs, opts?: InvokeOptions): Promise<GetServerGroupResult>
function getServerGroupOutput(args: GetServerGroupOutputArgs, opts?: InvokeOptions): Output<GetServerGroupResult>

def get_server_group(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetServerGroupResult
def get_server_group_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetServerGroupResult]

func LookupServerGroup(ctx *Context, args *LookupServerGroupArgs, opts ...InvokeOption) (*LookupServerGroupResult, error)
func LookupServerGroupOutput(ctx *Context, args *LookupServerGroupOutputArgs, opts ...InvokeOption) LookupServerGroupResultOutput

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

public static class GetServerGroup 
{
    public static Task<GetServerGroupResult> InvokeAsync(GetServerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetServerGroupResult> Invoke(GetServerGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServerGroupResult> getServerGroup(GetServerGroupArgs args, InvokeOptions options)
public static Output<GetServerGroupResult> getServerGroup(GetServerGroupArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:alb/getServerGroup:getServerGroup
  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.

getServerGroup Result

The following output properties are available:

CreateTime string: 后端服务器组的创建时间。
Description string: 后端服务器组的描述。
HealthCheck Volcengine.GetServerGroupHealthCheck: 服务器组健康检查配置信息。
Id string: Uniquely identifies the resource.
IpAddressType string: 服务器组的IP地址类型。目前只支持 IPv4
Listeners List<Volcengine.GetServerGroupListener>: 后端服务器组关联的监听器信息。
ProjectName string: 后端服务器组所属项目名称。
Protocol string: 后端协议：HTTP，HTTPS。
Scheduler string: 调度算法。取值：wrr：加权轮询。wlc：加权最小连接数。sh：源地址哈希。
ServerCount int: 服务器组内后端服务器的个数。
ServerGroupId string: 后端服务器组的ID。
ServerGroupName string: 后端服务器组的名称。
ServerGroupType string: 后端服务器组的类型。instance：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。
Servers List<Volcengine.GetServerGroupServer>: 后端服务器组中服务器的信息。
Status string: 服务器组状态。Creating：创建中。Active：运行中。Configuring：配置中。Deleting：删除中。
StickySessionConfig Volcengine.GetServerGroupStickySessionConfig: 会话保持功能的参数信息。
Tags List<Volcengine.GetServerGroupTag>: 标签信息。
UpdateTime string: 后端服务器组的最近操作时间。
VpcId string: 后端服务器组所属 Vpc 的 ID。

CreateTime string: 后端服务器组的创建时间。
Description string: 后端服务器组的描述。
HealthCheck GetServerGroupHealthCheck: 服务器组健康检查配置信息。
Id string: Uniquely identifies the resource.
IpAddressType string: 服务器组的IP地址类型。目前只支持 IPv4
Listeners []GetServerGroupListener: 后端服务器组关联的监听器信息。
ProjectName string: 后端服务器组所属项目名称。
Protocol string: 后端协议：HTTP，HTTPS。
Scheduler string: 调度算法。取值：wrr：加权轮询。wlc：加权最小连接数。sh：源地址哈希。
ServerCount int: 服务器组内后端服务器的个数。
ServerGroupId string: 后端服务器组的ID。
ServerGroupName string: 后端服务器组的名称。
ServerGroupType string: 后端服务器组的类型。instance：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。
Servers []GetServerGroupServer: 后端服务器组中服务器的信息。
Status string: 服务器组状态。Creating：创建中。Active：运行中。Configuring：配置中。Deleting：删除中。
StickySessionConfig GetServerGroupStickySessionConfig: 会话保持功能的参数信息。
Tags []GetServerGroupTag: 标签信息。
UpdateTime string: 后端服务器组的最近操作时间。
VpcId string: 后端服务器组所属 Vpc 的 ID。

createTime String: 后端服务器组的创建时间。
description String: 后端服务器组的描述。
healthCheck GetServerGroupHealthCheck: 服务器组健康检查配置信息。
id String: Uniquely identifies the resource.
ipAddressType String: 服务器组的IP地址类型。目前只支持 IPv4
listeners List<GetServerGroupListener>: 后端服务器组关联的监听器信息。
projectName String: 后端服务器组所属项目名称。
protocol String: 后端协议：HTTP，HTTPS。
scheduler String: 调度算法。取值：wrr：加权轮询。wlc：加权最小连接数。sh：源地址哈希。
serverCount Integer: 服务器组内后端服务器的个数。
serverGroupId String: 后端服务器组的ID。
serverGroupName String: 后端服务器组的名称。
serverGroupType String: 后端服务器组的类型。instance：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。
servers List<GetServerGroupServer>: 后端服务器组中服务器的信息。
status String: 服务器组状态。Creating：创建中。Active：运行中。Configuring：配置中。Deleting：删除中。
stickySessionConfig GetServerGroupStickySessionConfig: 会话保持功能的参数信息。
tags List<GetServerGroupTag>: 标签信息。
updateTime String: 后端服务器组的最近操作时间。
vpcId String: 后端服务器组所属 Vpc 的 ID。

createTime string: 后端服务器组的创建时间。
description string: 后端服务器组的描述。
healthCheck GetServerGroupHealthCheck: 服务器组健康检查配置信息。
id string: Uniquely identifies the resource.
ipAddressType string: 服务器组的IP地址类型。目前只支持 IPv4
listeners GetServerGroupListener[]: 后端服务器组关联的监听器信息。
projectName string: 后端服务器组所属项目名称。
protocol string: 后端协议：HTTP，HTTPS。
scheduler string: 调度算法。取值：wrr：加权轮询。wlc：加权最小连接数。sh：源地址哈希。
serverCount number: 服务器组内后端服务器的个数。
serverGroupId string: 后端服务器组的ID。
serverGroupName string: 后端服务器组的名称。
serverGroupType string: 后端服务器组的类型。instance：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。
servers GetServerGroupServer[]: 后端服务器组中服务器的信息。
status string: 服务器组状态。Creating：创建中。Active：运行中。Configuring：配置中。Deleting：删除中。
stickySessionConfig GetServerGroupStickySessionConfig: 会话保持功能的参数信息。
tags GetServerGroupTag[]: 标签信息。
updateTime string: 后端服务器组的最近操作时间。
vpcId string: 后端服务器组所属 Vpc 的 ID。

create_time str: 后端服务器组的创建时间。
description str: 后端服务器组的描述。
health_check GetServerGroupHealthCheck: 服务器组健康检查配置信息。
id str: Uniquely identifies the resource.
ip_address_type str: 服务器组的IP地址类型。目前只支持 IPv4
listeners Sequence[GetServerGroupListener]: 后端服务器组关联的监听器信息。
project_name str: 后端服务器组所属项目名称。
protocol str: 后端协议：HTTP，HTTPS。
scheduler str: 调度算法。取值：wrr：加权轮询。wlc：加权最小连接数。sh：源地址哈希。
server_count int: 服务器组内后端服务器的个数。
server_group_id str: 后端服务器组的ID。
server_group_name str: 后端服务器组的名称。
server_group_type str: 后端服务器组的类型。instance：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。
servers Sequence[GetServerGroupServer]: 后端服务器组中服务器的信息。
status str: 服务器组状态。Creating：创建中。Active：运行中。Configuring：配置中。Deleting：删除中。
sticky_session_config GetServerGroupStickySessionConfig: 会话保持功能的参数信息。
tags Sequence[GetServerGroupTag]: 标签信息。
update_time str: 后端服务器组的最近操作时间。
vpc_id str: 后端服务器组所属 Vpc 的 ID。

createTime String: 后端服务器组的创建时间。
description String: 后端服务器组的描述。
healthCheck Property Map: 服务器组健康检查配置信息。
id String: Uniquely identifies the resource.
ipAddressType String: 服务器组的IP地址类型。目前只支持 IPv4
listeners List<Property Map>: 后端服务器组关联的监听器信息。
projectName String: 后端服务器组所属项目名称。
protocol String: 后端协议：HTTP，HTTPS。
scheduler String: 调度算法。取值：wrr：加权轮询。wlc：加权最小连接数。sh：源地址哈希。
serverCount Number: 服务器组内后端服务器的个数。
serverGroupId String: 后端服务器组的ID。
serverGroupName String: 后端服务器组的名称。
serverGroupType String: 后端服务器组的类型。instance：服务器类型，该类型服务器组支持添加 ecs、eni 实例作为后端服务器。ip：IP类型，该类型服务器组支持添加 IP 地址作为后端服务器。
servers List<Property Map>: 后端服务器组中服务器的信息。
status String: 服务器组状态。Creating：创建中。Active：运行中。Configuring：配置中。Deleting：删除中。
stickySessionConfig Property Map: 会话保持功能的参数信息。
tags List<Property Map>: 标签信息。
updateTime String: 后端服务器组的最近操作时间。
vpcId String: 后端服务器组所属 Vpc 的 ID。

Supporting Types

GetServerGroupHealthCheck

Domain string: 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。需至少包含一个‘.’，且不允许以‘.’开头或结尾。域名每一级由字母、数字、‘-’、‘.’字符组成，且‘-’不得出现在每一级的头部或尾部。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为空，表示负载均衡使用各后端服务器的私网IP地址进行健康检查。
Enabled string: 监听器是否开启健康检查功能。取值：on：开启（默认值）。off：不开启。
HealthyThreshold int: 健康检查的健康阈值。表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。单位：次，取值：2~10，默认值为 3。
HttpCode string: 健康检查正常的HTTP状态码，多个状态码间用半角逗号分隔。只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值如下：http2xx（默认值）。http3xx（默认值）。http4xx 。http5xx 。
HttpVersion string: 健康检查HTTP协议版本，只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值：HTTP1.0（使用API时，HTTP协议版本默认值）。HTTP1.1。
Interval int: 开启健康检查后，执行健康检查的时间间隔。单位：秒，取值：1~300s，默认值为 2。
Method string: 开启健康检查后，健康检查的方法。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：GET：服务器需支持GET方法。HEAD（默认）：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但服务器需要支持HEAD方法。
Port int: 健康检查端口。支持取值：0（默认值）：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
Protocol string: 健康检查协议，当前支持HTTP、TCP。默认值为 HTTP。
Timeout int: 健康检查的响应超时时间。表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。单位：秒，取值：1~60，默认值为 2。
UnhealthyThreshold int: 健康检查的不健康阈值。表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。单位：次，取值：2~10，默认值为 3。
Uri string: 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’ 字符。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为“/”。

Domain string: 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。需至少包含一个‘.’，且不允许以‘.’开头或结尾。域名每一级由字母、数字、‘-’、‘.’字符组成，且‘-’不得出现在每一级的头部或尾部。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为空，表示负载均衡使用各后端服务器的私网IP地址进行健康检查。
Enabled string: 监听器是否开启健康检查功能。取值：on：开启（默认值）。off：不开启。
HealthyThreshold int: 健康检查的健康阈值。表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。单位：次，取值：2~10，默认值为 3。
HttpCode string: 健康检查正常的HTTP状态码，多个状态码间用半角逗号分隔。只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值如下：http2xx（默认值）。http3xx（默认值）。http4xx 。http5xx 。
HttpVersion string: 健康检查HTTP协议版本，只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值：HTTP1.0（使用API时，HTTP协议版本默认值）。HTTP1.1。
Interval int: 开启健康检查后，执行健康检查的时间间隔。单位：秒，取值：1~300s，默认值为 2。
Method string: 开启健康检查后，健康检查的方法。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：GET：服务器需支持GET方法。HEAD（默认）：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但服务器需要支持HEAD方法。
Port int: 健康检查端口。支持取值：0（默认值）：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
Protocol string: 健康检查协议，当前支持HTTP、TCP。默认值为 HTTP。
Timeout int: 健康检查的响应超时时间。表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。单位：秒，取值：1~60，默认值为 2。
UnhealthyThreshold int: 健康检查的不健康阈值。表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。单位：次，取值：2~10，默认值为 3。
Uri string: 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’ 字符。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为“/”。

domain String: 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。需至少包含一个‘.’，且不允许以‘.’开头或结尾。域名每一级由字母、数字、‘-’、‘.’字符组成，且‘-’不得出现在每一级的头部或尾部。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为空，表示负载均衡使用各后端服务器的私网IP地址进行健康检查。
enabled String: 监听器是否开启健康检查功能。取值：on：开启（默认值）。off：不开启。
healthyThreshold Integer: 健康检查的健康阈值。表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。单位：次，取值：2~10，默认值为 3。
httpCode String: 健康检查正常的HTTP状态码，多个状态码间用半角逗号分隔。只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值如下：http2xx（默认值）。http3xx（默认值）。http4xx 。http5xx 。
httpVersion String: 健康检查HTTP协议版本，只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值：HTTP1.0（使用API时，HTTP协议版本默认值）。HTTP1.1。
interval Integer: 开启健康检查后，执行健康检查的时间间隔。单位：秒，取值：1~300s，默认值为 2。
method String: 开启健康检查后，健康检查的方法。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：GET：服务器需支持GET方法。HEAD（默认）：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但服务器需要支持HEAD方法。
port Integer: 健康检查端口。支持取值：0（默认值）：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
protocol String: 健康检查协议，当前支持HTTP、TCP。默认值为 HTTP。
timeout Integer: 健康检查的响应超时时间。表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。单位：秒，取值：1~60，默认值为 2。
unhealthyThreshold Integer: 健康检查的不健康阈值。表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。单位：次，取值：2~10，默认值为 3。
uri String: 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’ 字符。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为“/”。

domain string: 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。需至少包含一个‘.’，且不允许以‘.’开头或结尾。域名每一级由字母、数字、‘-’、‘.’字符组成，且‘-’不得出现在每一级的头部或尾部。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为空，表示负载均衡使用各后端服务器的私网IP地址进行健康检查。
enabled string: 监听器是否开启健康检查功能。取值：on：开启（默认值）。off：不开启。
healthyThreshold number: 健康检查的健康阈值。表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。单位：次，取值：2~10，默认值为 3。
httpCode string: 健康检查正常的HTTP状态码，多个状态码间用半角逗号分隔。只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值如下：http2xx（默认值）。http3xx（默认值）。http4xx 。http5xx 。
httpVersion string: 健康检查HTTP协议版本，只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值：HTTP1.0（使用API时，HTTP协议版本默认值）。HTTP1.1。
interval number: 开启健康检查后，执行健康检查的时间间隔。单位：秒，取值：1~300s，默认值为 2。
method string: 开启健康检查后，健康检查的方法。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：GET：服务器需支持GET方法。HEAD（默认）：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但服务器需要支持HEAD方法。
port number: 健康检查端口。支持取值：0（默认值）：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
protocol string: 健康检查协议，当前支持HTTP、TCP。默认值为 HTTP。
timeout number: 健康检查的响应超时时间。表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。单位：秒，取值：1~60，默认值为 2。
unhealthyThreshold number: 健康检查的不健康阈值。表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。单位：次，取值：2~10，默认值为 3。
uri string: 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’ 字符。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为“/”。

domain str: 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。需至少包含一个‘.’，且不允许以‘.’开头或结尾。域名每一级由字母、数字、‘-’、‘.’字符组成，且‘-’不得出现在每一级的头部或尾部。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为空，表示负载均衡使用各后端服务器的私网IP地址进行健康检查。
enabled str: 监听器是否开启健康检查功能。取值：on：开启（默认值）。off：不开启。
healthy_threshold int: 健康检查的健康阈值。表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。单位：次，取值：2~10，默认值为 3。
http_code str: 健康检查正常的HTTP状态码，多个状态码间用半角逗号分隔。只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值如下：http2xx（默认值）。http3xx（默认值）。http4xx 。http5xx 。
http_version str: 健康检查HTTP协议版本，只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值：HTTP1.0（使用API时，HTTP协议版本默认值）。HTTP1.1。
interval int: 开启健康检查后，执行健康检查的时间间隔。单位：秒，取值：1~300s，默认值为 2。
method str: 开启健康检查后，健康检查的方法。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：GET：服务器需支持GET方法。HEAD（默认）：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但服务器需要支持HEAD方法。
port int: 健康检查端口。支持取值：0（默认值）：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
protocol str: 健康检查协议，当前支持HTTP、TCP。默认值为 HTTP。
timeout int: 健康检查的响应超时时间。表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。单位：秒，取值：1~60，默认值为 2。
unhealthy_threshold int: 健康检查的不健康阈值。表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。单位：次，取值：2~10，默认值为 3。
uri str: 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’ 字符。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为“/”。

domain String: 健康检查的域名，需配置为后端服务器上真实对外提供服务的地址。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。需至少包含一个‘.’，且不允许以‘.’开头或结尾。域名每一级由字母、数字、‘-’、‘.’字符组成，且‘-’不得出现在每一级的头部或尾部。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为空，表示负载均衡使用各后端服务器的私网IP地址进行健康检查。
enabled String: 监听器是否开启健康检查功能。取值：on：开启（默认值）。off：不开启。
healthyThreshold Number: 健康检查的健康阈值。表示连续执行指定次数的健康检查，结果均为正常的后端服务器将判定为健康检查正常。单位：次，取值：2~10，默认值为 3。
httpCode String: 健康检查正常的HTTP状态码，多个状态码间用半角逗号分隔。只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值如下：http2xx（默认值）。http3xx（默认值）。http4xx 。http5xx 。
httpVersion String: 健康检查HTTP协议版本，只有 HealthCheck.Protocol 为 HTTP 时才存在该参数。取值：HTTP1.0（使用API时，HTTP协议版本默认值）。HTTP1.1。
interval Number: 开启健康检查后，执行健康检查的时间间隔。单位：秒，取值：1~300s，默认值为 2。
method String: 开启健康检查后，健康检查的方法。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。取值如下：GET：服务器需支持GET方法。HEAD（默认）：服务器仅返回HEAD头部信息，可以降低后端性能消耗，但服务器需要支持HEAD方法。
port Number: 健康检查端口。支持取值：0（默认值）：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
protocol String: 健康检查协议，当前支持HTTP、TCP。默认值为 HTTP。
timeout Number: 健康检查的响应超时时间。表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。单位：秒，取值：1~60，默认值为 2。
unhealthyThreshold Number: 健康检查的不健康阈值。表示连续执行指定次数的健康检查，结果均为异常的后端服务器将判定为健康检查异常。单位：次，取值：2~10，默认值为 3。
uri String: 健康检查的路径，需配置为后端服务器上真实对外提供的路径。只有 HealthCheck.Protocol 设置为 HTTP 时该参数生效。必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’ 字符。长度限制为1 ～ 128个字符。不传入该参数或该参数不传入数值时，默认为“/”。

GetServerGroupListener

ListenerId string: 监听器的ID。

ListenerId string: 监听器的ID。

listenerId String: 监听器的ID。

listenerId string: 监听器的ID。

listener_id str: 监听器的ID。

listenerId String: 监听器的ID。

GetServerGroupServer

Description string: 后端服务器的描述。
InstanceId string: 云服务器实例或网卡的ID。
Ip string: 后端服务器的私网IP地址。
Port int: 后端服务器接收请求的端口号。
RemoteEnabled string: 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。取值：on：开启。off（默认值）：不开启。
ServerId string: 后端服务器ID。
Type string: 后端服务器实例类型。ecs：云服务器实例。eni：辅助网卡。ip：IP地址（仅 Ip 类型服务器组有效）。
Weight int: 后端服务器的权重。

Description string: 后端服务器的描述。
InstanceId string: 云服务器实例或网卡的ID。
Ip string: 后端服务器的私网IP地址。
Port int: 后端服务器接收请求的端口号。
RemoteEnabled string: 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。取值：on：开启。off（默认值）：不开启。
ServerId string: 后端服务器ID。
Type string: 后端服务器实例类型。ecs：云服务器实例。eni：辅助网卡。ip：IP地址（仅 Ip 类型服务器组有效）。
Weight int: 后端服务器的权重。

description String: 后端服务器的描述。
instanceId String: 云服务器实例或网卡的ID。
ip String: 后端服务器的私网IP地址。
port Integer: 后端服务器接收请求的端口号。
remoteEnabled String: 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。取值：on：开启。off（默认值）：不开启。
serverId String: 后端服务器ID。
type String: 后端服务器实例类型。ecs：云服务器实例。eni：辅助网卡。ip：IP地址（仅 Ip 类型服务器组有效）。
weight Integer: 后端服务器的权重。

description string: 后端服务器的描述。
instanceId string: 云服务器实例或网卡的ID。
ip string: 后端服务器的私网IP地址。
port number: 后端服务器接收请求的端口号。
remoteEnabled string: 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。取值：on：开启。off（默认值）：不开启。
serverId string: 后端服务器ID。
type string: 后端服务器实例类型。ecs：云服务器实例。eni：辅助网卡。ip：IP地址（仅 Ip 类型服务器组有效）。
weight number: 后端服务器的权重。

description str: 后端服务器的描述。
instance_id str: 云服务器实例或网卡的ID。
ip str: 后端服务器的私网IP地址。
port int: 后端服务器接收请求的端口号。
remote_enabled str: 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。取值：on：开启。off（默认值）：不开启。
server_id str: 后端服务器ID。
type str: 后端服务器实例类型。ecs：云服务器实例。eni：辅助网卡。ip：IP地址（仅 Ip 类型服务器组有效）。
weight int: 后端服务器的权重。

description String: 后端服务器的描述。
instanceId String: 云服务器实例或网卡的ID。
ip String: 后端服务器的私网IP地址。
port Number: 后端服务器接收请求的端口号。
remoteEnabled String: 是否开启远端IP功能。当后端服务器实例类型为IP地址，即 Type 取值为 ip 时，此字段有效。取值：on：开启。off（默认值）：不开启。
serverId String: 后端服务器ID。
type String: 后端服务器实例类型。ecs：云服务器实例。eni：辅助网卡。ip：IP地址（仅 Ip 类型服务器组有效）。
weight Number: 后端服务器的权重。

GetServerGroupStickySessionConfig

Cookie string: 服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。具体规则如下：Cookie 名称长度为1~200个字符。名称只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。当 tickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 server时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，该参数无效。
CookieTimeout int: 会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。单位：秒。具体规则如下：超时时间的取值范围：1～86400。默认值为：1000。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 server 时，此参数无效。
StickySessionEnabled string: 是否开启会话保持功能。on：开启；off（默认值）：关闭。
StickySessionType string: 对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时，此字段参数必填。取值如下：insert：植入 Cookie；ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。server：重写 Cookie；开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

Cookie string: 服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。具体规则如下：Cookie 名称长度为1~200个字符。名称只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。当 tickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 server时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，该参数无效。
CookieTimeout int: 会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。单位：秒。具体规则如下：超时时间的取值范围：1～86400。默认值为：1000。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 server 时，此参数无效。
StickySessionEnabled string: 是否开启会话保持功能。on：开启；off（默认值）：关闭。
StickySessionType string: 对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时，此字段参数必填。取值如下：insert：植入 Cookie；ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。server：重写 Cookie；开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

cookie String: 服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。具体规则如下：Cookie 名称长度为1~200个字符。名称只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。当 tickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 server时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，该参数无效。
cookieTimeout Integer: 会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。单位：秒。具体规则如下：超时时间的取值范围：1～86400。默认值为：1000。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 server 时，此参数无效。
stickySessionEnabled String: 是否开启会话保持功能。on：开启；off（默认值）：关闭。
stickySessionType String: 对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时，此字段参数必填。取值如下：insert：植入 Cookie；ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。server：重写 Cookie；开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

cookie string: 服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。具体规则如下：Cookie 名称长度为1~200个字符。名称只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。当 tickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 server时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，该参数无效。
cookieTimeout number: 会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。单位：秒。具体规则如下：超时时间的取值范围：1～86400。默认值为：1000。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 server 时，此参数无效。
stickySessionEnabled string: 是否开启会话保持功能。on：开启；off（默认值）：关闭。
stickySessionType string: 对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时，此字段参数必填。取值如下：insert：植入 Cookie；ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。server：重写 Cookie；开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

cookie str: 服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。具体规则如下：Cookie 名称长度为1~200个字符。名称只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。当 tickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 server时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，该参数无效。
cookie_timeout int: 会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。单位：秒。具体规则如下：超时时间的取值范围：1～86400。默认值为：1000。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 server 时，此参数无效。
sticky_session_enabled str: 是否开启会话保持功能。on：开启；off（默认值）：关闭。
sticky_session_type str: 对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时，此字段参数必填。取值如下：insert：植入 Cookie；ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。server：重写 Cookie；开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

cookie String: 服务配置的会话保持 Cookie 名称。仅在开启会话保持功能并选择重写 Cookie 时有效。具体规则如下：Cookie 名称长度为1~200个字符。名称只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。当 tickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 server时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，该参数无效。
cookieTimeout Number: 会话保持 Cookie 超时时间。仅在开启会话保持功能并选择植入 Cookie 时有效。单位：秒。具体规则如下：超时时间的取值范围：1～86400。默认值为：1000。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionConfig.StickySessionType 为 insert 时，此参数必填。当 StickySessionConfig.StickySessionEnabled 值为 on，且 StickySessionType 为 server 时，此参数无效。
stickySessionEnabled String: 是否开启会话保持功能。on：开启；off（默认值）：关闭。
stickySessionType String: 对 Cookie 的处理方式。当 StickySessionConfig.StickySessionEnabled 值为 on 时，此字段参数必填。取值如下：insert：植入 Cookie；ALB 会记录客户端请求第一次转发到的后端服务器。ALB 在返回请求中植入 Cookie ，后续客户端请求携带此 Cookie，ALB 会将请求转发到之前记录的后端服务器上。server：重写 Cookie；开启重写 Cookie 的会话保持后，在客户端请求第一次转发到后端服务器后，ALB 在返回请求中发现您自定义的 Cookie 时，会对原来的 Cookie 进行重写。后续客户端请求携带改写后的 Cookie，ALB 会将请求转发到之前记录的后端服务器上。

GetServerGroupTag

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: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

volcenginecc v0.0.3 published on Thursday, Oct 30, 2025 by Volcengine

volcengine/pulumi-volcenginecc

volcenginecc.alb.getServerGroup

On this page

On this page

Using getServerGroup

getServerGroup Result

Supporting Types

GetServerGroupHealthCheck

GetServerGroupListener

GetServerGroupServer

GetServerGroupStickySessionConfig

GetServerGroupTag

Package Details

On this page

On this page