Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
published on Friday, Mar 13, 2026 by Volcengine
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
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 dictionaryThe following arguments are supported:
- Instance
Ids List<string> - Output
File string - Project
Name string - Server
Group List<string>Ids - Server
Group stringName - Server
Ips List<string> -
List<Get
Server Groups Tag> - Type string
- Vpc
Id string
- Instance
Ids []string - Output
File string - Project
Name string - Server
Group []stringIds - Server
Group stringName - Server
Ips []string -
[]Get
Server Groups Tag - Type string
- Vpc
Id string
- instance
Ids List<String> - output
File String - project
Name String - server
Group List<String>Ids - server
Group StringName - server
Ips List<String> -
List<Get
Server Groups Tag> - type String
- vpc
Id String
- instance
Ids string[] - output
File string - project
Name string - server
Group string[]Ids - server
Group stringName - server
Ips string[] -
Get
Server Groups Tag[] - type string
- vpc
Id string
- instance_
ids Sequence[str] - output_
file str - project_
name str - server_
group_ Sequence[str]ids - server_
group_ strname - server_
ips Sequence[str] -
Sequence[Get
Server Groups Tag] - type str
- vpc_
id str
- instance
Ids List<String> - output
File String - project
Name String - server
Group List<String>Ids - server
Group StringName - server
Ips List<String> - List<Property Map>
- type String
- vpc
Id String
getServerGroups Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Server
Groups List<GetServer Groups Server Group> - Total
Count int - Instance
Ids List<string> - Output
File string - Project
Name string - Server
Group List<string>Ids - Server
Group stringName - Server
Ips List<string> -
List<Get
Server Groups Tag> - Type string
- Vpc
Id string
- Id string
- The provider-assigned unique ID for this managed resource.
- Server
Groups []GetServer Groups Server Group - Total
Count int - Instance
Ids []string - Output
File string - Project
Name string - Server
Group []stringIds - Server
Group stringName - Server
Ips []string -
[]Get
Server Groups Tag - Type string
- Vpc
Id string
- id String
- The provider-assigned unique ID for this managed resource.
- server
Groups List<GetServer Groups Server Group> - total
Count Integer - instance
Ids List<String> - output
File String - project
Name String - server
Group List<String>Ids - server
Group StringName - server
Ips List<String> -
List<Get
Server Groups Tag> - type String
- vpc
Id String
- id string
- The provider-assigned unique ID for this managed resource.
- server
Groups GetServer Groups Server Group[] - total
Count number - instance
Ids string[] - output
File string - project
Name string - server
Group string[]Ids - server
Group stringName - server
Ips string[] -
Get
Server Groups Tag[] - type string
- vpc
Id string
- id str
- The provider-assigned unique ID for this managed resource.
- server_
groups Sequence[GetServer Groups Server Group] - total_
count int - instance_
ids Sequence[str] - output_
file str - project_
name str - server_
group_ Sequence[str]ids - server_
group_ strname - server_
ips Sequence[str] -
Sequence[Get
Server Groups Tag] - type str
- vpc_
id str
- id String
- The provider-assigned unique ID for this managed resource.
- server
Groups List<Property Map> - total
Count Number - instance
Ids List<String> - output
File String - project
Name String - server
Group List<String>Ids - server
Group StringName - server
Ips List<String> - List<Property Map>
- type String
- vpc
Id String
Supporting Types
GetServerGroupsServerGroup
- Account
Id string - The account ID of the server group.
- Any
Port boolEnabled - Whether to enable full port forwarding. Valid values:
true,false.true: Enable.false: Disable. - Bypass
Security boolGroup Enabled - Whether to enable the function of passing through the backend security group. Valid values:
true,false.true: Enable.false: Disable. - Connection
Drain boolEnabled - Whether to enable connection graceful interruption. Valid values:
true,false.true: Enable.false: Disable. - Connection
Drain intTimeout - The timeout period of connection graceful interruption.
- Create
Time string - The creation time of the server group.
- Description string
- The description of the server group.
- Health
Checks List<GetServer Groups Server Group Health Check> - The health check config of the server group.
- Ip
Address stringVersion - The IP address version of the server group. Valid values:
ipv4,ipv6. - Preserve
Client boolIp Enabled - Whether to enable source address retention. Valid values:
true,false.true: Enable.false: Disable. - Project
Name string - The project name of the server group.
- Protocol string
- The protocol of the server group. Valid values:
TCP,UDP,TCP_SSL. - Proxy
Protocol stringType - 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. - List<string>
- The ID of the NLB instance associated with the server group.
- Scheduler string
- The scheduling algorithm. Valid values:
wrr,wlc,sh. - Server
Count int - The number of backend servers in the server group.
- Server
Group stringId - The ID of the server group.
- Server
Group stringName - The name of the server group.
- Session
Persistence boolEnabled - Whether to enable session persistence. Valid values:
true,false.true: Enable.false: Disable. - Session
Persistence intTimeout - The timeout period of session persistence.
- Status string
- The status of the server group.
-
List<Get
Server Groups Server Group Tag> - Tags.
- Timestamp
Remove boolEnabled - 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. - Update
Time string - The update time of the server group.
- Vpc
Id string - The ID of the VPC to which the server group belongs.
- Account
Id string - The account ID of the server group.
- Any
Port boolEnabled - Whether to enable full port forwarding. Valid values:
true,false.true: Enable.false: Disable. - Bypass
Security boolGroup Enabled - Whether to enable the function of passing through the backend security group. Valid values:
true,false.true: Enable.false: Disable. - Connection
Drain boolEnabled - Whether to enable connection graceful interruption. Valid values:
true,false.true: Enable.false: Disable. - Connection
Drain intTimeout - The timeout period of connection graceful interruption.
- Create
Time string - The creation time of the server group.
- Description string
- The description of the server group.
- Health
Checks []GetServer Groups Server Group Health Check - The health check config of the server group.
- Ip
Address stringVersion - The IP address version of the server group. Valid values:
ipv4,ipv6. - Preserve
Client boolIp Enabled - Whether to enable source address retention. Valid values:
true,false.true: Enable.false: Disable. - Project
Name string - The project name of the server group.
- Protocol string
- The protocol of the server group. Valid values:
TCP,UDP,TCP_SSL. - Proxy
Protocol stringType - 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. - []string
- The ID of the NLB instance associated with the server group.
- Scheduler string
- The scheduling algorithm. Valid values:
wrr,wlc,sh. - Server
Count int - The number of backend servers in the server group.
- Server
Group stringId - The ID of the server group.
- Server
Group stringName - The name of the server group.
- Session
Persistence boolEnabled - Whether to enable session persistence. Valid values:
true,false.true: Enable.false: Disable. - Session
Persistence intTimeout - The timeout period of session persistence.
- Status string
- The status of the server group.
-
[]Get
Server Groups Server Group Tag - Tags.
- Timestamp
Remove boolEnabled - 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. - Update
Time string - The update time of the server group.
- Vpc
Id string - The ID of the VPC to which the server group belongs.
- account
Id String - The account ID of the server group.
- any
Port BooleanEnabled - Whether to enable full port forwarding. Valid values:
true,false.true: Enable.false: Disable. - bypass
Security BooleanGroup Enabled - Whether to enable the function of passing through the backend security group. Valid values:
true,false.true: Enable.false: Disable. - connection
Drain BooleanEnabled - Whether to enable connection graceful interruption. Valid values:
true,false.true: Enable.false: Disable. - connection
Drain IntegerTimeout - The timeout period of connection graceful interruption.
- create
Time String - The creation time of the server group.
- description String
- The description of the server group.
- health
Checks List<GetServer Groups Server Group Health Check> - The health check config of the server group.
- ip
Address StringVersion - The IP address version of the server group. Valid values:
ipv4,ipv6. - preserve
Client BooleanIp Enabled - Whether to enable source address retention. Valid values:
true,false.true: Enable.false: Disable. - project
Name String - The project name of the server group.
- protocol String
- The protocol of the server group. Valid values:
TCP,UDP,TCP_SSL. - proxy
Protocol StringType - 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. - List<String>
- The ID of the NLB instance associated with the server group.
- scheduler String
- The scheduling algorithm. Valid values:
wrr,wlc,sh. - server
Count Integer - The number of backend servers in the server group.
- server
Group StringId - The ID of the server group.
- server
Group StringName - The name of the server group.
- session
Persistence BooleanEnabled - Whether to enable session persistence. Valid values:
true,false.true: Enable.false: Disable. - session
Persistence IntegerTimeout - The timeout period of session persistence.
- status String
- The status of the server group.
-
List<Get
Server Groups Server Group Tag> - Tags.
- timestamp
Remove BooleanEnabled - 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. - update
Time String - The update time of the server group.
- vpc
Id String - The ID of the VPC to which the server group belongs.
- account
Id string - The account ID of the server group.
- any
Port booleanEnabled - Whether to enable full port forwarding. Valid values:
true,false.true: Enable.false: Disable. - bypass
Security booleanGroup Enabled - Whether to enable the function of passing through the backend security group. Valid values:
true,false.true: Enable.false: Disable. - connection
Drain booleanEnabled - Whether to enable connection graceful interruption. Valid values:
true,false.true: Enable.false: Disable. - connection
Drain numberTimeout - The timeout period of connection graceful interruption.
- create
Time string - The creation time of the server group.
- description string
- The description of the server group.
- health
Checks GetServer Groups Server Group Health Check[] - The health check config of the server group.
- ip
Address stringVersion - The IP address version of the server group. Valid values:
ipv4,ipv6. - preserve
Client booleanIp Enabled - Whether to enable source address retention. Valid values:
true,false.true: Enable.false: Disable. - project
Name string - The project name of the server group.
- protocol string
- The protocol of the server group. Valid values:
TCP,UDP,TCP_SSL. - proxy
Protocol stringType - 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. - string[]
- The ID of the NLB instance associated with the server group.
- scheduler string
- The scheduling algorithm. Valid values:
wrr,wlc,sh. - server
Count number - The number of backend servers in the server group.
- server
Group stringId - The ID of the server group.
- server
Group stringName - The name of the server group.
- session
Persistence booleanEnabled - Whether to enable session persistence. Valid values:
true,false.true: Enable.false: Disable. - session
Persistence numberTimeout - The timeout period of session persistence.
- status string
- The status of the server group.
-
Get
Server Groups Server Group Tag[] - Tags.
- timestamp
Remove booleanEnabled - 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. - update
Time string - The update time of the server group.
- vpc
Id string - The ID of the VPC to which the server group belongs.
- account_
id str - The account ID of the server group.
- any_
port_ boolenabled - Whether to enable full port forwarding. Valid values:
true,false.true: Enable.false: Disable. - bypass_
security_ boolgroup_ enabled - Whether to enable the function of passing through the backend security group. Valid values:
true,false.true: Enable.false: Disable. - connection_
drain_ boolenabled - Whether to enable connection graceful interruption. Valid values:
true,false.true: Enable.false: Disable. - connection_
drain_ inttimeout - 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[GetServer Groups Server Group Health Check] - The health check config of the server group.
- ip_
address_ strversion - The IP address version of the server group. Valid values:
ipv4,ipv6. - preserve_
client_ boolip_ enabled - 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_ strtype - 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. - 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_ strid - The ID of the server group.
- server_
group_ strname - The name of the server group.
- session_
persistence_ boolenabled - Whether to enable session persistence. Valid values:
true,false.true: Enable.false: Disable. - session_
persistence_ inttimeout - The timeout period of session persistence.
- status str
- The status of the server group.
-
Sequence[Get
Server Groups Server Group Tag] - Tags.
- timestamp_
remove_ boolenabled - 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.
- account
Id String - The account ID of the server group.
- any
Port BooleanEnabled - Whether to enable full port forwarding. Valid values:
true,false.true: Enable.false: Disable. - bypass
Security BooleanGroup Enabled - Whether to enable the function of passing through the backend security group. Valid values:
true,false.true: Enable.false: Disable. - connection
Drain BooleanEnabled - Whether to enable connection graceful interruption. Valid values:
true,false.true: Enable.false: Disable. - connection
Drain NumberTimeout - The timeout period of connection graceful interruption.
- create
Time String - The creation time of the server group.
- description String
- The description of the server group.
- health
Checks List<Property Map> - The health check config of the server group.
- ip
Address StringVersion - The IP address version of the server group. Valid values:
ipv4,ipv6. - preserve
Client BooleanIp Enabled - Whether to enable source address retention. Valid values:
true,false.true: Enable.false: Disable. - project
Name String - The project name of the server group.
- protocol String
- The protocol of the server group. Valid values:
TCP,UDP,TCP_SSL. - proxy
Protocol StringType - 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. - List<String>
- The ID of the NLB instance associated with the server group.
- scheduler String
- The scheduling algorithm. Valid values:
wrr,wlc,sh. - server
Count Number - The number of backend servers in the server group.
- server
Group StringId - The ID of the server group.
- server
Group StringName - The name of the server group.
- session
Persistence BooleanEnabled - Whether to enable session persistence. Valid values:
true,false.true: Enable.false: Disable. - session
Persistence NumberTimeout - The timeout period of session persistence.
- status String
- The status of the server group.
- List<Property Map>
- Tags.
- timestamp
Remove BooleanEnabled - 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. - update
Time String - The update time of the server group.
- vpc
Id 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. - Healthy
Threshold int - The healthy threshold of health check.
- Http
Code 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. - Udp
Connect intTimeout - The udp connect timeout of the health check.
- Udp
Expect string - The expected response string for UDP health check.
- Udp
Request string - The request string for UDP health check.
- Unhealthy
Threshold 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. - Healthy
Threshold int - The healthy threshold of health check.
- Http
Code 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. - Udp
Connect intTimeout - The udp connect timeout of the health check.
- Udp
Expect string - The expected response string for UDP health check.
- Udp
Request string - The request string for UDP health check.
- Unhealthy
Threshold 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. - healthy
Threshold Integer - The healthy threshold of health check.
- http
Code 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. - udp
Connect IntegerTimeout - The udp connect timeout of the health check.
- udp
Expect String - The expected response string for UDP health check.
- udp
Request String - The request string for UDP health check.
- unhealthy
Threshold 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. - healthy
Threshold number - The healthy threshold of health check.
- http
Code 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. - udp
Connect numberTimeout - The udp connect timeout of the health check.
- udp
Expect string - The expected response string for UDP health check.
- udp
Request string - The request string for UDP health check.
- unhealthy
Threshold 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_ inttimeout - 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. - healthy
Threshold Number - The healthy threshold of health check.
- http
Code 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. - udp
Connect NumberTimeout - The udp connect timeout of the health check.
- udp
Expect String - The expected response string for UDP health check.
- udp
Request String - The request string for UDP health check.
- unhealthy
Threshold Number - The unhealthy threshold of health check.
- uri String
- The uri of health check.
GetServerGroupsServerGroupTag
GetServerGroupsTag
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengineTerraform Provider.
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
published on Friday, Mar 13, 2026 by Volcengine
