1. Packages
  2. Volcengine
  3. API Docs
  4. nlb
  5. getServerGroups
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine

    Using getServerGroups

    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 getServerGroups(args: GetServerGroupsArgs, opts?: InvokeOptions): Promise<GetServerGroupsResult>
    function getServerGroupsOutput(args: GetServerGroupsOutputArgs, opts?: InvokeOptions): Output<GetServerGroupsResult>
    def get_server_groups(instance_ids: Optional[Sequence[str]] = None,
                          output_file: Optional[str] = None,
                          project_name: Optional[str] = None,
                          server_group_ids: Optional[Sequence[str]] = None,
                          server_group_name: Optional[str] = None,
                          server_ips: Optional[Sequence[str]] = None,
                          tags: Optional[Sequence[GetServerGroupsTag]] = None,
                          type: Optional[str] = None,
                          vpc_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetServerGroupsResult
    def get_server_groups_output(instance_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          output_file: Optional[pulumi.Input[str]] = None,
                          project_name: Optional[pulumi.Input[str]] = None,
                          server_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          server_group_name: Optional[pulumi.Input[str]] = None,
                          server_ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetServerGroupsTagArgs]]]] = None,
                          type: Optional[pulumi.Input[str]] = None,
                          vpc_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetServerGroupsResult]
    func GetServerGroups(ctx *Context, args *GetServerGroupsArgs, opts ...InvokeOption) (*GetServerGroupsResult, error)
    func GetServerGroupsOutput(ctx *Context, args *GetServerGroupsOutputArgs, opts ...InvokeOption) GetServerGroupsResultOutput

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

    public static class GetServerGroups 
    {
        public static Task<GetServerGroupsResult> InvokeAsync(GetServerGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetServerGroupsResult> Invoke(GetServerGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServerGroupsResult> getServerGroups(GetServerGroupsArgs args, InvokeOptions options)
    public static Output<GetServerGroupsResult> getServerGroups(GetServerGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:nlb/getServerGroups:getServerGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceIds List<string>
    OutputFile string
    ProjectName string
    ServerGroupIds List<string>
    ServerGroupName string
    ServerIps List<string>
    Tags List<GetServerGroupsTag>
    Type string
    VpcId string
    instanceIds List<String>
    outputFile String
    projectName String
    serverGroupIds List<String>
    serverGroupName String
    serverIps List<String>
    tags List<GetServerGroupsTag>
    type String
    vpcId String
    instanceIds List<String>
    outputFile String
    projectName String
    serverGroupIds List<String>
    serverGroupName String
    serverIps List<String>
    tags List<Property Map>
    type String
    vpcId String

    getServerGroups Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ServerGroups List<GetServerGroupsServerGroup>
    TotalCount int
    InstanceIds List<string>
    OutputFile string
    ProjectName string
    ServerGroupIds List<string>
    ServerGroupName string
    ServerIps List<string>
    Tags List<GetServerGroupsTag>
    Type string
    VpcId string
    Id string
    The provider-assigned unique ID for this managed resource.
    ServerGroups []GetServerGroupsServerGroup
    TotalCount int
    InstanceIds []string
    OutputFile string
    ProjectName string
    ServerGroupIds []string
    ServerGroupName string
    ServerIps []string
    Tags []GetServerGroupsTag
    Type string
    VpcId string
    id String
    The provider-assigned unique ID for this managed resource.
    serverGroups List<GetServerGroupsServerGroup>
    totalCount Integer
    instanceIds List<String>
    outputFile String
    projectName String
    serverGroupIds List<String>
    serverGroupName String
    serverIps List<String>
    tags List<GetServerGroupsTag>
    type String
    vpcId String
    id string
    The provider-assigned unique ID for this managed resource.
    serverGroups GetServerGroupsServerGroup[]
    totalCount number
    instanceIds string[]
    outputFile string
    projectName string
    serverGroupIds string[]
    serverGroupName string
    serverIps string[]
    tags GetServerGroupsTag[]
    type string
    vpcId string
    id str
    The provider-assigned unique ID for this managed resource.
    server_groups Sequence[GetServerGroupsServerGroup]
    total_count int
    instance_ids Sequence[str]
    output_file str
    project_name str
    server_group_ids Sequence[str]
    server_group_name str
    server_ips Sequence[str]
    tags Sequence[GetServerGroupsTag]
    type str
    vpc_id str
    id String
    The provider-assigned unique ID for this managed resource.
    serverGroups List<Property Map>
    totalCount Number
    instanceIds List<String>
    outputFile String
    projectName String
    serverGroupIds List<String>
    serverGroupName String
    serverIps List<String>
    tags List<Property Map>
    type String
    vpcId String

    Supporting Types

    GetServerGroupsServerGroup

    AccountId string
    The account ID of the server group.
    AnyPortEnabled bool
    Whether to enable full port forwarding. Valid values: true, false. true: Enable. false: Disable.
    BypassSecurityGroupEnabled bool
    Whether to enable the function of passing through the backend security group. Valid values: true, false. true: Enable. false: Disable.
    ConnectionDrainEnabled bool
    Whether to enable connection graceful interruption. Valid values: true, false. true: Enable. false: Disable.
    ConnectionDrainTimeout int
    The timeout period of connection graceful interruption.
    CreateTime string
    The creation time of the server group.
    Description string
    The description of the server group.
    HealthChecks List<GetServerGroupsServerGroupHealthCheck>
    The health check config of the server group.
    IpAddressVersion string
    The IP address version of the server group. Valid values: ipv4, ipv6.
    PreserveClientIpEnabled bool
    Whether to enable source address retention. Valid values: true, false. true: Enable. false: Disable.
    ProjectName string
    The project name of the server group.
    Protocol string
    The protocol of the server group. Valid values: TCP, UDP, TCP_SSL.
    ProxyProtocolType string
    Whether to enable Proxy-Protocol. Valid values: off, standard. off: Disable. standard: Enable. NLB will forward the client source IP address to the server via Proxy-Protocol, and Proxy-Protocol needs to be configured on the server.
    RelatedLoadBalancerIds List<string>
    The ID of the NLB instance associated with the server group.
    Scheduler string
    The scheduling algorithm. Valid values: wrr, wlc, sh.
    ServerCount int
    The number of backend servers in the server group.
    ServerGroupId string
    The ID of the server group.
    ServerGroupName string
    The name of the server group.
    SessionPersistenceEnabled bool
    Whether to enable session persistence. Valid values: true, false. true: Enable. false: Disable.
    SessionPersistenceTimeout int
    The timeout period of session persistence.
    Status string
    The status of the server group.
    Tags List<GetServerGroupsServerGroupTag>
    Tags.
    TimestampRemoveEnabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Valid values: true, false. true: Enable. false: Disable.
    Type string
    The type of the server group. Valid values: instance, ip. instance: Server type. Supports adding ECS instances and secondary ENIs bound to ECS instances. ip: IP address type. Supports adding any network-reachable servers in VPC or IDC.
    UpdateTime string
    The update time of the server group.
    VpcId string
    The ID of the VPC to which the server group belongs.
    AccountId string
    The account ID of the server group.
    AnyPortEnabled bool
    Whether to enable full port forwarding. Valid values: true, false. true: Enable. false: Disable.
    BypassSecurityGroupEnabled bool
    Whether to enable the function of passing through the backend security group. Valid values: true, false. true: Enable. false: Disable.
    ConnectionDrainEnabled bool
    Whether to enable connection graceful interruption. Valid values: true, false. true: Enable. false: Disable.
    ConnectionDrainTimeout int
    The timeout period of connection graceful interruption.
    CreateTime string
    The creation time of the server group.
    Description string
    The description of the server group.
    HealthChecks []GetServerGroupsServerGroupHealthCheck
    The health check config of the server group.
    IpAddressVersion string
    The IP address version of the server group. Valid values: ipv4, ipv6.
    PreserveClientIpEnabled bool
    Whether to enable source address retention. Valid values: true, false. true: Enable. false: Disable.
    ProjectName string
    The project name of the server group.
    Protocol string
    The protocol of the server group. Valid values: TCP, UDP, TCP_SSL.
    ProxyProtocolType string
    Whether to enable Proxy-Protocol. Valid values: off, standard. off: Disable. standard: Enable. NLB will forward the client source IP address to the server via Proxy-Protocol, and Proxy-Protocol needs to be configured on the server.
    RelatedLoadBalancerIds []string
    The ID of the NLB instance associated with the server group.
    Scheduler string
    The scheduling algorithm. Valid values: wrr, wlc, sh.
    ServerCount int
    The number of backend servers in the server group.
    ServerGroupId string
    The ID of the server group.
    ServerGroupName string
    The name of the server group.
    SessionPersistenceEnabled bool
    Whether to enable session persistence. Valid values: true, false. true: Enable. false: Disable.
    SessionPersistenceTimeout int
    The timeout period of session persistence.
    Status string
    The status of the server group.
    Tags []GetServerGroupsServerGroupTag
    Tags.
    TimestampRemoveEnabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Valid values: true, false. true: Enable. false: Disable.
    Type string
    The type of the server group. Valid values: instance, ip. instance: Server type. Supports adding ECS instances and secondary ENIs bound to ECS instances. ip: IP address type. Supports adding any network-reachable servers in VPC or IDC.
    UpdateTime string
    The update time of the server group.
    VpcId string
    The ID of the VPC to which the server group belongs.
    accountId String
    The account ID of the server group.
    anyPortEnabled Boolean
    Whether to enable full port forwarding. Valid values: true, false. true: Enable. false: Disable.
    bypassSecurityGroupEnabled Boolean
    Whether to enable the function of passing through the backend security group. Valid values: true, false. true: Enable. false: Disable.
    connectionDrainEnabled Boolean
    Whether to enable connection graceful interruption. Valid values: true, false. true: Enable. false: Disable.
    connectionDrainTimeout Integer
    The timeout period of connection graceful interruption.
    createTime String
    The creation time of the server group.
    description String
    The description of the server group.
    healthChecks List<GetServerGroupsServerGroupHealthCheck>
    The health check config of the server group.
    ipAddressVersion String
    The IP address version of the server group. Valid values: ipv4, ipv6.
    preserveClientIpEnabled Boolean
    Whether to enable source address retention. Valid values: true, false. true: Enable. false: Disable.
    projectName String
    The project name of the server group.
    protocol String
    The protocol of the server group. Valid values: TCP, UDP, TCP_SSL.
    proxyProtocolType String
    Whether to enable Proxy-Protocol. Valid values: off, standard. off: Disable. standard: Enable. NLB will forward the client source IP address to the server via Proxy-Protocol, and Proxy-Protocol needs to be configured on the server.
    relatedLoadBalancerIds List<String>
    The ID of the NLB instance associated with the server group.
    scheduler String
    The scheduling algorithm. Valid values: wrr, wlc, sh.
    serverCount Integer
    The number of backend servers in the server group.
    serverGroupId String
    The ID of the server group.
    serverGroupName String
    The name of the server group.
    sessionPersistenceEnabled Boolean
    Whether to enable session persistence. Valid values: true, false. true: Enable. false: Disable.
    sessionPersistenceTimeout Integer
    The timeout period of session persistence.
    status String
    The status of the server group.
    tags List<GetServerGroupsServerGroupTag>
    Tags.
    timestampRemoveEnabled Boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Valid values: true, false. true: Enable. false: Disable.
    type String
    The type of the server group. Valid values: instance, ip. instance: Server type. Supports adding ECS instances and secondary ENIs bound to ECS instances. ip: IP address type. Supports adding any network-reachable servers in VPC or IDC.
    updateTime String
    The update time of the server group.
    vpcId String
    The ID of the VPC to which the server group belongs.
    accountId string
    The account ID of the server group.
    anyPortEnabled boolean
    Whether to enable full port forwarding. Valid values: true, false. true: Enable. false: Disable.
    bypassSecurityGroupEnabled boolean
    Whether to enable the function of passing through the backend security group. Valid values: true, false. true: Enable. false: Disable.
    connectionDrainEnabled boolean
    Whether to enable connection graceful interruption. Valid values: true, false. true: Enable. false: Disable.
    connectionDrainTimeout number
    The timeout period of connection graceful interruption.
    createTime string
    The creation time of the server group.
    description string
    The description of the server group.
    healthChecks GetServerGroupsServerGroupHealthCheck[]
    The health check config of the server group.
    ipAddressVersion string
    The IP address version of the server group. Valid values: ipv4, ipv6.
    preserveClientIpEnabled boolean
    Whether to enable source address retention. Valid values: true, false. true: Enable. false: Disable.
    projectName string
    The project name of the server group.
    protocol string
    The protocol of the server group. Valid values: TCP, UDP, TCP_SSL.
    proxyProtocolType string
    Whether to enable Proxy-Protocol. Valid values: off, standard. off: Disable. standard: Enable. NLB will forward the client source IP address to the server via Proxy-Protocol, and Proxy-Protocol needs to be configured on the server.
    relatedLoadBalancerIds string[]
    The ID of the NLB instance associated with the server group.
    scheduler string
    The scheduling algorithm. Valid values: wrr, wlc, sh.
    serverCount number
    The number of backend servers in the server group.
    serverGroupId string
    The ID of the server group.
    serverGroupName string
    The name of the server group.
    sessionPersistenceEnabled boolean
    Whether to enable session persistence. Valid values: true, false. true: Enable. false: Disable.
    sessionPersistenceTimeout number
    The timeout period of session persistence.
    status string
    The status of the server group.
    tags GetServerGroupsServerGroupTag[]
    Tags.
    timestampRemoveEnabled boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Valid values: true, false. true: Enable. false: Disable.
    type string
    The type of the server group. Valid values: instance, ip. instance: Server type. Supports adding ECS instances and secondary ENIs bound to ECS instances. ip: IP address type. Supports adding any network-reachable servers in VPC or IDC.
    updateTime string
    The update time of the server group.
    vpcId string
    The ID of the VPC to which the server group belongs.
    account_id str
    The account ID of the server group.
    any_port_enabled bool
    Whether to enable full port forwarding. Valid values: true, false. true: Enable. false: Disable.
    bypass_security_group_enabled bool
    Whether to enable the function of passing through the backend security group. Valid values: true, false. true: Enable. false: Disable.
    connection_drain_enabled bool
    Whether to enable connection graceful interruption. Valid values: true, false. true: Enable. false: Disable.
    connection_drain_timeout int
    The timeout period of connection graceful interruption.
    create_time str
    The creation time of the server group.
    description str
    The description of the server group.
    health_checks Sequence[GetServerGroupsServerGroupHealthCheck]
    The health check config of the server group.
    ip_address_version str
    The IP address version of the server group. Valid values: ipv4, ipv6.
    preserve_client_ip_enabled bool
    Whether to enable source address retention. Valid values: true, false. true: Enable. false: Disable.
    project_name str
    The project name of the server group.
    protocol str
    The protocol of the server group. Valid values: TCP, UDP, TCP_SSL.
    proxy_protocol_type str
    Whether to enable Proxy-Protocol. Valid values: off, standard. off: Disable. standard: Enable. NLB will forward the client source IP address to the server via Proxy-Protocol, and Proxy-Protocol needs to be configured on the server.
    related_load_balancer_ids Sequence[str]
    The ID of the NLB instance associated with the server group.
    scheduler str
    The scheduling algorithm. Valid values: wrr, wlc, sh.
    server_count int
    The number of backend servers in the server group.
    server_group_id str
    The ID of the server group.
    server_group_name str
    The name of the server group.
    session_persistence_enabled bool
    Whether to enable session persistence. Valid values: true, false. true: Enable. false: Disable.
    session_persistence_timeout int
    The timeout period of session persistence.
    status str
    The status of the server group.
    tags Sequence[GetServerGroupsServerGroupTag]
    Tags.
    timestamp_remove_enabled bool
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Valid values: true, false. true: Enable. false: Disable.
    type str
    The type of the server group. Valid values: instance, ip. instance: Server type. Supports adding ECS instances and secondary ENIs bound to ECS instances. ip: IP address type. Supports adding any network-reachable servers in VPC or IDC.
    update_time str
    The update time of the server group.
    vpc_id str
    The ID of the VPC to which the server group belongs.
    accountId String
    The account ID of the server group.
    anyPortEnabled Boolean
    Whether to enable full port forwarding. Valid values: true, false. true: Enable. false: Disable.
    bypassSecurityGroupEnabled Boolean
    Whether to enable the function of passing through the backend security group. Valid values: true, false. true: Enable. false: Disable.
    connectionDrainEnabled Boolean
    Whether to enable connection graceful interruption. Valid values: true, false. true: Enable. false: Disable.
    connectionDrainTimeout Number
    The timeout period of connection graceful interruption.
    createTime String
    The creation time of the server group.
    description String
    The description of the server group.
    healthChecks List<Property Map>
    The health check config of the server group.
    ipAddressVersion String
    The IP address version of the server group. Valid values: ipv4, ipv6.
    preserveClientIpEnabled Boolean
    Whether to enable source address retention. Valid values: true, false. true: Enable. false: Disable.
    projectName String
    The project name of the server group.
    protocol String
    The protocol of the server group. Valid values: TCP, UDP, TCP_SSL.
    proxyProtocolType String
    Whether to enable Proxy-Protocol. Valid values: off, standard. off: Disable. standard: Enable. NLB will forward the client source IP address to the server via Proxy-Protocol, and Proxy-Protocol needs to be configured on the server.
    relatedLoadBalancerIds List<String>
    The ID of the NLB instance associated with the server group.
    scheduler String
    The scheduling algorithm. Valid values: wrr, wlc, sh.
    serverCount Number
    The number of backend servers in the server group.
    serverGroupId String
    The ID of the server group.
    serverGroupName String
    The name of the server group.
    sessionPersistenceEnabled Boolean
    Whether to enable session persistence. Valid values: true, false. true: Enable. false: Disable.
    sessionPersistenceTimeout Number
    The timeout period of session persistence.
    status String
    The status of the server group.
    tags List<Property Map>
    Tags.
    timestampRemoveEnabled Boolean
    Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Valid values: true, false. true: Enable. false: Disable.
    type String
    The type of the server group. Valid values: instance, ip. instance: Server type. Supports adding ECS instances and secondary ENIs bound to ECS instances. ip: IP address type. Supports adding any network-reachable servers in VPC or IDC.
    updateTime String
    The update time of the server group.
    vpcId String
    The ID of the VPC to which the server group belongs.

    GetServerGroupsServerGroupHealthCheck

    Domain string
    The domain of health check.
    Enabled bool
    Whether to enable health check. Valid values: true, false. true: Enable. false: Disable.
    HealthyThreshold int
    The healthy threshold of health check.
    HttpCode string
    The normal HTTP status code for health check.
    Interval int
    The interval of health check.
    Method string
    The method of health check. Valid values: GET, HEAD.
    Port int
    The port of health check. 0 indicates the port of the backend server.
    Timeout int
    The timeout period of health check response.
    Type string
    The type of health check. Valid values: TCP, HTTP, UDP. TCP: Send SYN handshake packets to detect the port status of the backend server. HTTP: Send HEAD or GET requests to simulate browsing access behavior to detect whether the backend application is normal. UDP: Send ICMP or UDP detection packets to detect whether the backend server is normal.
    UdpConnectTimeout int
    The udp connect timeout of the health check.
    UdpExpect string
    The expected response string for UDP health check.
    UdpRequest string
    The request string for UDP health check.
    UnhealthyThreshold int
    The unhealthy threshold of health check.
    Uri string
    The uri of health check.
    Domain string
    The domain of health check.
    Enabled bool
    Whether to enable health check. Valid values: true, false. true: Enable. false: Disable.
    HealthyThreshold int
    The healthy threshold of health check.
    HttpCode string
    The normal HTTP status code for health check.
    Interval int
    The interval of health check.
    Method string
    The method of health check. Valid values: GET, HEAD.
    Port int
    The port of health check. 0 indicates the port of the backend server.
    Timeout int
    The timeout period of health check response.
    Type string
    The type of health check. Valid values: TCP, HTTP, UDP. TCP: Send SYN handshake packets to detect the port status of the backend server. HTTP: Send HEAD or GET requests to simulate browsing access behavior to detect whether the backend application is normal. UDP: Send ICMP or UDP detection packets to detect whether the backend server is normal.
    UdpConnectTimeout int
    The udp connect timeout of the health check.
    UdpExpect string
    The expected response string for UDP health check.
    UdpRequest string
    The request string for UDP health check.
    UnhealthyThreshold int
    The unhealthy threshold of health check.
    Uri string
    The uri of health check.
    domain String
    The domain of health check.
    enabled Boolean
    Whether to enable health check. Valid values: true, false. true: Enable. false: Disable.
    healthyThreshold Integer
    The healthy threshold of health check.
    httpCode String
    The normal HTTP status code for health check.
    interval Integer
    The interval of health check.
    method String
    The method of health check. Valid values: GET, HEAD.
    port Integer
    The port of health check. 0 indicates the port of the backend server.
    timeout Integer
    The timeout period of health check response.
    type String
    The type of health check. Valid values: TCP, HTTP, UDP. TCP: Send SYN handshake packets to detect the port status of the backend server. HTTP: Send HEAD or GET requests to simulate browsing access behavior to detect whether the backend application is normal. UDP: Send ICMP or UDP detection packets to detect whether the backend server is normal.
    udpConnectTimeout Integer
    The udp connect timeout of the health check.
    udpExpect String
    The expected response string for UDP health check.
    udpRequest String
    The request string for UDP health check.
    unhealthyThreshold Integer
    The unhealthy threshold of health check.
    uri String
    The uri of health check.
    domain string
    The domain of health check.
    enabled boolean
    Whether to enable health check. Valid values: true, false. true: Enable. false: Disable.
    healthyThreshold number
    The healthy threshold of health check.
    httpCode string
    The normal HTTP status code for health check.
    interval number
    The interval of health check.
    method string
    The method of health check. Valid values: GET, HEAD.
    port number
    The port of health check. 0 indicates the port of the backend server.
    timeout number
    The timeout period of health check response.
    type string
    The type of health check. Valid values: TCP, HTTP, UDP. TCP: Send SYN handshake packets to detect the port status of the backend server. HTTP: Send HEAD or GET requests to simulate browsing access behavior to detect whether the backend application is normal. UDP: Send ICMP or UDP detection packets to detect whether the backend server is normal.
    udpConnectTimeout number
    The udp connect timeout of the health check.
    udpExpect string
    The expected response string for UDP health check.
    udpRequest string
    The request string for UDP health check.
    unhealthyThreshold number
    The unhealthy threshold of health check.
    uri string
    The uri of health check.
    domain str
    The domain of health check.
    enabled bool
    Whether to enable health check. Valid values: true, false. true: Enable. false: Disable.
    healthy_threshold int
    The healthy threshold of health check.
    http_code str
    The normal HTTP status code for health check.
    interval int
    The interval of health check.
    method str
    The method of health check. Valid values: GET, HEAD.
    port int
    The port of health check. 0 indicates the port of the backend server.
    timeout int
    The timeout period of health check response.
    type str
    The type of health check. Valid values: TCP, HTTP, UDP. TCP: Send SYN handshake packets to detect the port status of the backend server. HTTP: Send HEAD or GET requests to simulate browsing access behavior to detect whether the backend application is normal. UDP: Send ICMP or UDP detection packets to detect whether the backend server is normal.
    udp_connect_timeout int
    The udp connect timeout of the health check.
    udp_expect str
    The expected response string for UDP health check.
    udp_request str
    The request string for UDP health check.
    unhealthy_threshold int
    The unhealthy threshold of health check.
    uri str
    The uri of health check.
    domain String
    The domain of health check.
    enabled Boolean
    Whether to enable health check. Valid values: true, false. true: Enable. false: Disable.
    healthyThreshold Number
    The healthy threshold of health check.
    httpCode String
    The normal HTTP status code for health check.
    interval Number
    The interval of health check.
    method String
    The method of health check. Valid values: GET, HEAD.
    port Number
    The port of health check. 0 indicates the port of the backend server.
    timeout Number
    The timeout period of health check response.
    type String
    The type of health check. Valid values: TCP, HTTP, UDP. TCP: Send SYN handshake packets to detect the port status of the backend server. HTTP: Send HEAD or GET requests to simulate browsing access behavior to detect whether the backend application is normal. UDP: Send ICMP or UDP detection packets to detect whether the backend server is normal.
    udpConnectTimeout Number
    The udp connect timeout of the health check.
    udpExpect String
    The expected response string for UDP health check.
    udpRequest String
    The request string for UDP health check.
    unhealthyThreshold Number
    The unhealthy threshold of health check.
    uri String
    The uri of health check.

    GetServerGroupsServerGroupTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetServerGroupsTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.