1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. alb
  6. getServerGroup
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.alb.getServerGroup

bytepluscc logo
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::ALB::ServerGroup

    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: pulumi.Input[Optional[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: bytepluscc: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
    Creation time of the backend server group.
    CrossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    Description string
    Description of the backend server group.
    HealthCheck Byteplus.GetServerGroupHealthCheck
    Health check configuration information for the server group.
    Id string
    Uniquely identifies the resource.
    IpAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    Listeners List<Byteplus.GetServerGroupListener>
    Listener information associated with the backend server group.
    ProjectName string
    Name of the project to which the backend server group belongs.
    Protocol string
    Backend protocol: HTTP, HTTPS.
    Scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    ServerCount int
    Number of backend servers in the server group.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    Backend server group name.
    ServerGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    Servers List<Byteplus.GetServerGroupServer>
    Information about the servers in the backend server group.
    Status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    StickySessionConfig Byteplus.GetServerGroupStickySessionConfig
    Session persistence parameter information.
    Tags List<Byteplus.GetServerGroupTag>
    Tag information.
    UpdateTime string
    Last operation time of the backend server group.
    VpcId string
    ID of the VPC to which the backend server group belongs.
    CreateTime string
    Creation time of the backend server group.
    CrossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    Description string
    Description of the backend server group.
    HealthCheck GetServerGroupHealthCheck
    Health check configuration information for the server group.
    Id string
    Uniquely identifies the resource.
    IpAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    Listeners []GetServerGroupListener
    Listener information associated with the backend server group.
    ProjectName string
    Name of the project to which the backend server group belongs.
    Protocol string
    Backend protocol: HTTP, HTTPS.
    Scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    ServerCount int
    Number of backend servers in the server group.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    Backend server group name.
    ServerGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    Servers []GetServerGroupServer
    Information about the servers in the backend server group.
    Status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    StickySessionConfig GetServerGroupStickySessionConfig
    Session persistence parameter information.
    Tags []GetServerGroupTag
    Tag information.
    UpdateTime string
    Last operation time of the backend server group.
    VpcId string
    ID of the VPC to which the backend server group belongs.
    createTime String
    Creation time of the backend server group.
    crossZoneEnabled String
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description String
    Description of the backend server group.
    healthCheck GetServerGroupHealthCheck
    Health check configuration information for the server group.
    id String
    Uniquely identifies the resource.
    ipAddressType String
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners List<GetServerGroupListener>
    Listener information associated with the backend server group.
    projectName String
    Name of the project to which the backend server group belongs.
    protocol String
    Backend protocol: HTTP, HTTPS.
    scheduler String
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverCount Integer
    Number of backend servers in the server group.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    Backend server group name.
    serverGroupType String
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers List<GetServerGroupServer>
    Information about the servers in the backend server group.
    status String
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig GetServerGroupStickySessionConfig
    Session persistence parameter information.
    tags List<GetServerGroupTag>
    Tag information.
    updateTime String
    Last operation time of the backend server group.
    vpcId String
    ID of the VPC to which the backend server group belongs.
    createTime string
    Creation time of the backend server group.
    crossZoneEnabled string
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description string
    Description of the backend server group.
    healthCheck GetServerGroupHealthCheck
    Health check configuration information for the server group.
    id string
    Uniquely identifies the resource.
    ipAddressType string
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners GetServerGroupListener[]
    Listener information associated with the backend server group.
    projectName string
    Name of the project to which the backend server group belongs.
    protocol string
    Backend protocol: HTTP, HTTPS.
    scheduler string
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverCount number
    Number of backend servers in the server group.
    serverGroupId string
    Backend server group ID.
    serverGroupName string
    Backend server group name.
    serverGroupType string
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers GetServerGroupServer[]
    Information about the servers in the backend server group.
    status string
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig GetServerGroupStickySessionConfig
    Session persistence parameter information.
    tags GetServerGroupTag[]
    Tag information.
    updateTime string
    Last operation time of the backend server group.
    vpcId string
    ID of the VPC to which the backend server group belongs.
    create_time str
    Creation time of the backend server group.
    cross_zone_enabled str
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description str
    Description of the backend server group.
    health_check GetServerGroupHealthCheck
    Health check configuration information for the server group.
    id str
    Uniquely identifies the resource.
    ip_address_type str
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners Sequence[GetServerGroupListener]
    Listener information associated with the backend server group.
    project_name str
    Name of the project to which the backend server group belongs.
    protocol str
    Backend protocol: HTTP, HTTPS.
    scheduler str
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    server_count int
    Number of backend servers in the server group.
    server_group_id str
    Backend server group ID.
    server_group_name str
    Backend server group name.
    server_group_type str
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers Sequence[GetServerGroupServer]
    Information about the servers in the backend server group.
    status str
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    sticky_session_config GetServerGroupStickySessionConfig
    Session persistence parameter information.
    tags Sequence[GetServerGroupTag]
    Tag information.
    update_time str
    Last operation time of the backend server group.
    vpc_id str
    ID of the VPC to which the backend server group belongs.
    createTime String
    Creation time of the backend server group.
    crossZoneEnabled String
    Enable cross-availability zone load balancing for the server group. Options: on (default): enabled; off: disabled.
    description String
    Description of the backend server group.
    healthCheck Property Map
    Health check configuration information for the server group.
    id String
    Uniquely identifies the resource.
    ipAddressType String
    IP address type of the server group. Currently, only IPv4 is supported.
    listeners List<Property Map>
    Listener information associated with the backend server group.
    projectName String
    Name of the project to which the backend server group belongs.
    protocol String
    Backend protocol: HTTP, HTTPS.
    scheduler String
    Scheduling algorithm. Options: wrr: weighted round robin; wlc: weighted least connection; sh: source address hash.
    serverCount Number
    Number of backend servers in the server group.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    Backend server group name.
    serverGroupType String
    Type of backend server group. instance: server type, supports adding ECS and ENI instances as backend servers. ip: IP type, supports adding IP addresses as backend servers.
    servers List<Property Map>
    Information about the servers in the backend server group.
    status String
    Server group status. Creating: Being created. Active: Running. Configuring: Being configured. Deleting: Being deleted.
    stickySessionConfig Property Map
    Session persistence parameter information.
    tags List<Property Map>
    Tag information.
    updateTime String
    Last operation time of the backend server group.
    vpcId String
    ID of the VPC to which the backend server group belongs.

    Supporting Types

    GetServerGroupHealthCheck

    Domain string
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    Enabled string
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    HealthyThreshold int
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    HttpCode string
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    HttpVersion string
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    Interval int
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    Method string
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    Port int
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    Protocol string
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    Timeout int
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    UnhealthyThreshold int
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    Uri string
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    Domain string
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    Enabled string
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    HealthyThreshold int
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    HttpCode string
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    HttpVersion string
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    Interval int
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    Method string
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    Port int
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    Protocol string
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    Timeout int
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    UnhealthyThreshold int
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    Uri string
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain String
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled String
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthyThreshold Integer
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    httpCode String
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    httpVersion String
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval Integer
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method String
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port Integer
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol String
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout Integer
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthyThreshold Integer
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri String
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain string
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled string
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthyThreshold number
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    httpCode string
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    httpVersion string
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval number
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method string
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port number
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol string
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout number
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthyThreshold number
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri string
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain str
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled str
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthy_threshold int
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    http_code str
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    http_version str
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval int
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method str
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port int
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol str
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout int
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthy_threshold int
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri str
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.
    domain String
    The domain name for health checks must be configured as the actual address used by the backend server to provide external services. This parameter is only effective when HealthCheck.Protocol is set to HTTP. The domain name must contain at least one '.', and cannot start or end with a '.'. Each level of the domain name can include letters, numbers, '-', and '.' characters, but '-' cannot appear at the beginning or end of any level. Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, it defaults to empty, meaning the load balancer uses the private IP address of each backend server for health checks.
    enabled String
    Whether the listener has enabled health check. Values: on: enabled (default), off: disabled.
    healthyThreshold Number
    Health check threshold. Indicates that a backend server is considered healthy if it passes the specified number of consecutive health checks. Unit: checks. Range: 2–10. Default: 3.
    httpCode String
    HTTP status codes indicating a successful health check. Use commas to separate multiple codes. This parameter is only available when HealthCheck.Protocol is set to HTTP. Valid values: http2xx (default), http3xx (default), http4xx, http5xx.
    httpVersion String
    HTTP protocol version for health checks. This parameter is only available when HealthCheck.Protocol is set to HTTP. Values: HTTP1.0 (default when using API), HTTP1.1.
    interval Number
    After enabling health check, the interval for performing health checks. Unit: seconds. Range: 1–300s. Default: 2.
    method String
    After enabling health check, the health check method. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Values: GET: server must support the GET method. HEAD (default): server returns only HEAD header information, which can reduce backend performance consumption, but the server must support the HEAD method.
    port Number
    Health check port. Supported values: 0 (default): Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
    protocol String
    Health check protocol. Currently supports HTTP and TCP. Default: HTTP.
    timeout Number
    Health check response timeout. If the backend server does not respond correctly within the specified time, it is considered a health check failure. Unit: seconds; range: 1~60; default: 2.
    unhealthyThreshold Number
    Unhealthy threshold for health checks. If a backend server fails the specified number of consecutive health checks, it will be considered unhealthy. Unit: times. Value range: 2–10. Default: 3.
    uri String
    Health check path, which must be configured as the actual path provided by the backend server. This parameter is effective only when HealthCheck.Protocol is set to HTTP. Must start with '/'. Only letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' are allowed. Length must be between 1 and 128 characters. If this parameter is not specified or no value is provided, the default is '/'.

    GetServerGroupListener

    ListenerId string
    Listener ID.
    ListenerId string
    Listener ID.
    listenerId String
    Listener ID.
    listenerId string
    Listener ID.
    listener_id str
    Listener ID.
    listenerId String
    Listener ID.

    GetServerGroupServer

    Description string
    Description of the backend server.
    InstanceId string
    ID of the cloud server instance or network interface.
    Ip string
    Private IP address of the backend server.
    Port int
    Port number on which the backend server receives requests.
    RemoteEnabled string
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    ServerId string
    Backend server ID.
    Type string
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    Weight int
    Backend server weight.
    Description string
    Description of the backend server.
    InstanceId string
    ID of the cloud server instance or network interface.
    Ip string
    Private IP address of the backend server.
    Port int
    Port number on which the backend server receives requests.
    RemoteEnabled string
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    ServerId string
    Backend server ID.
    Type string
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    Weight int
    Backend server weight.
    description String
    Description of the backend server.
    instanceId String
    ID of the cloud server instance or network interface.
    ip String
    Private IP address of the backend server.
    port Integer
    Port number on which the backend server receives requests.
    remoteEnabled String
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    serverId String
    Backend server ID.
    type String
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight Integer
    Backend server weight.
    description string
    Description of the backend server.
    instanceId string
    ID of the cloud server instance or network interface.
    ip string
    Private IP address of the backend server.
    port number
    Port number on which the backend server receives requests.
    remoteEnabled string
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    serverId string
    Backend server ID.
    type string
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight number
    Backend server weight.
    description str
    Description of the backend server.
    instance_id str
    ID of the cloud server instance or network interface.
    ip str
    Private IP address of the backend server.
    port int
    Port number on which the backend server receives requests.
    remote_enabled str
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    server_id str
    Backend server ID.
    type str
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight int
    Backend server weight.
    description String
    Description of the backend server.
    instanceId String
    ID of the cloud server instance or network interface.
    ip String
    Private IP address of the backend server.
    port Number
    Port number on which the backend server receives requests.
    remoteEnabled String
    Enable remote IP feature. This field is valid when the backend server instance type is IP address, that is, when Type is set to ip. Values: on: enabled. off (default): disabled.
    serverId String
    Backend server ID.
    type String
    Backend server instance type. ECS: cloud server instance; ENI: secondary network interface; IP: IP address (only valid for IP-type server groups).
    weight Number
    Backend server weight.

    GetServerGroupStickySessionConfig

    Cookie string
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    CookieTimeout int
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    StickySessionEnabled string
    Enable session persistence. on: Enable; off (default): Disable.
    StickySessionType string
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    Cookie string
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    CookieTimeout int
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    StickySessionEnabled string
    Enable session persistence. on: Enable; off (default): Disable.
    StickySessionType string
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie String
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookieTimeout Integer
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    stickySessionEnabled String
    Enable session persistence. on: Enable; off (default): Disable.
    stickySessionType String
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie string
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookieTimeout number
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    stickySessionEnabled string
    Enable session persistence. on: Enable; off (default): Disable.
    stickySessionType string
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie str
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookie_timeout int
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    sticky_session_enabled str
    Enable session persistence. on: Enable; off (default): Disable.
    sticky_session_type str
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.
    cookie String
    Session persistence cookie name configured for the service. Only valid when session persistence is enabled and cookie rewrite is selected. Rules: Cookie name length must be 1–200 characters. The name can only contain ASCII letters and numbers, cannot include commas (,), semicolons (;), or spaces, and cannot start with a dollar sign ($). When stickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is server, this parameter is required. When StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert, this parameter is invalid.
    cookieTimeout Number
    Session persistence cookie timeout. Only effective when session persistence is enabled and cookie insertion is selected. Unit: seconds. Rules: timeout range: 1~86400; default: 1000. This parameter is required when StickySessionConfig.StickySessionEnabled is on and StickySessionConfig.StickySessionType is insert. This parameter is invalid when StickySessionConfig.StickySessionEnabled is on and StickySessionType is server.
    stickySessionEnabled String
    Enable session persistence. on: Enable; off (default): Disable.
    stickySessionType String
    Cookie handling method. When StickySessionConfig.StickySessionEnabled is set to on, this field is required. Values: insert: Insert a Cookie. ALB records the backend server to which the client's first request is forwarded. ALB inserts a Cookie in the response, and subsequent client requests carrying this Cookie are forwarded to the previously recorded backend server. server: Rewrite the Cookie. When session persistence with Cookie rewriting is enabled, after the client's first request is forwarded to the backend server, if ALB finds your custom Cookie in the response, it rewrites the original Cookie. Subsequent client requests carrying the rewritten Cookie are forwarded to the previously recorded backend server.

    GetServerGroupTag

    Key string
    Tag key. Duplicate tag keys are not allowed for the same resource.
    Value string
    Tag value.
    Key string
    Tag key. Duplicate tag keys are not allowed for the same resource.
    Value string
    Tag value.
    key String
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value String
    Tag value.
    key string
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value string
    Tag value.
    key str
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value str
    Tag value.
    key String
    Tag key. Duplicate tag keys are not allowed for the same resource.
    value String
    Tag value.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.25
    published on Thursday, May 7, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.