volcenginecc.alb.getHealthCheckTemplate

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getHealthCheckTemplate

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 getHealthCheckTemplate(args: GetHealthCheckTemplateArgs, opts?: InvokeOptions): Promise<GetHealthCheckTemplateResult>
function getHealthCheckTemplateOutput(args: GetHealthCheckTemplateOutputArgs, opts?: InvokeOptions): Output<GetHealthCheckTemplateResult>

def get_health_check_template(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetHealthCheckTemplateResult
def get_health_check_template_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetHealthCheckTemplateResult]

func LookupHealthCheckTemplate(ctx *Context, args *LookupHealthCheckTemplateArgs, opts ...InvokeOption) (*LookupHealthCheckTemplateResult, error)
func LookupHealthCheckTemplateOutput(ctx *Context, args *LookupHealthCheckTemplateOutputArgs, opts ...InvokeOption) LookupHealthCheckTemplateResultOutput

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

public static class GetHealthCheckTemplate 
{
    public static Task<GetHealthCheckTemplateResult> InvokeAsync(GetHealthCheckTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetHealthCheckTemplateResult> Invoke(GetHealthCheckTemplateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHealthCheckTemplateResult> getHealthCheckTemplate(GetHealthCheckTemplateArgs args, InvokeOptions options)
public static Output<GetHealthCheckTemplateResult> getHealthCheckTemplate(GetHealthCheckTemplateArgs args, InvokeOptions options)

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

getHealthCheckTemplate Result

The following output properties are available:

CreateTime string: Creation time of the health check template.
Description string: Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.
HealthCheckDomain string: Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.
HealthCheckHttpCode string: HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http2xx (default), http3xx (default), http4xx, http5xx.
HealthCheckHttpVersion string: HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
HealthCheckInterval int: Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
HealthCheckMethod string: Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
HealthCheckPort int: Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
HealthCheckProtocol string: Protocol for the health check. HTTP or TCP.
HealthCheckTemplateId string: Health check template ID.
HealthCheckTemplateName string: Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.
HealthCheckTimeout int: Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
HealthCheckUri string: Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.
HealthyThreshold int: Health threshold for the health check. Default is 3. Range: 2–10 times.
Id string: Uniquely identifies the resource.
ProjectName string: Project name to which the health check template belongs.
Tags List<Volcengine.GetHealthCheckTemplateTag>: List of tags associated with the health check template.
UnhealthyThreshold int: Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
UpdateTime string: Last operation time of the health check template.

CreateTime string: Creation time of the health check template.
Description string: Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.
HealthCheckDomain string: Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.
HealthCheckHttpCode string: HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http2xx (default), http3xx (default), http4xx, http5xx.
HealthCheckHttpVersion string: HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
HealthCheckInterval int: Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
HealthCheckMethod string: Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
HealthCheckPort int: Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
HealthCheckProtocol string: Protocol for the health check. HTTP or TCP.
HealthCheckTemplateId string: Health check template ID.
HealthCheckTemplateName string: Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.
HealthCheckTimeout int: Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
HealthCheckUri string: Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.
HealthyThreshold int: Health threshold for the health check. Default is 3. Range: 2–10 times.
Id string: Uniquely identifies the resource.
ProjectName string: Project name to which the health check template belongs.
Tags []GetHealthCheckTemplateTag: List of tags associated with the health check template.
UnhealthyThreshold int: Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
UpdateTime string: Last operation time of the health check template.

createTime String: Creation time of the health check template.
description String: Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.
healthCheckDomain String: Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.
healthCheckHttpCode String: HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http2xx (default), http3xx (default), http4xx, http5xx.
healthCheckHttpVersion String: HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
healthCheckInterval Integer: Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
healthCheckMethod String: Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
healthCheckPort Integer: Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
healthCheckProtocol String: Protocol for the health check. HTTP or TCP.
healthCheckTemplateId String: Health check template ID.
healthCheckTemplateName String: Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.
healthCheckTimeout Integer: Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
healthCheckUri String: Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.
healthyThreshold Integer: Health threshold for the health check. Default is 3. Range: 2–10 times.
id String: Uniquely identifies the resource.
projectName String: Project name to which the health check template belongs.
tags List<GetHealthCheckTemplateTag>: List of tags associated with the health check template.
unhealthyThreshold Integer: Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
updateTime String: Last operation time of the health check template.

createTime string: Creation time of the health check template.
description string: Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.
healthCheckDomain string: Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.
healthCheckHttpCode string: HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http2xx (default), http3xx (default), http4xx, http5xx.
healthCheckHttpVersion string: HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
healthCheckInterval number: Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
healthCheckMethod string: Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
healthCheckPort number: Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
healthCheckProtocol string: Protocol for the health check. HTTP or TCP.
healthCheckTemplateId string: Health check template ID.
healthCheckTemplateName string: Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.
healthCheckTimeout number: Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
healthCheckUri string: Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.
healthyThreshold number: Health threshold for the health check. Default is 3. Range: 2–10 times.
id string: Uniquely identifies the resource.
projectName string: Project name to which the health check template belongs.
tags GetHealthCheckTemplateTag[]: List of tags associated with the health check template.
unhealthyThreshold number: Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
updateTime string: Last operation time of the health check template.

create_time str: Creation time of the health check template.
description str: Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.
health_check_domain str: Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.
health_check_http_code str: HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http2xx (default), http3xx (default), http4xx, http5xx.
health_check_http_version str: HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
health_check_interval int: Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
health_check_method str: Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
health_check_port int: Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
health_check_protocol str: Protocol for the health check. HTTP or TCP.
health_check_template_id str: Health check template ID.
health_check_template_name str: Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.
health_check_timeout int: Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
health_check_uri str: Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.
healthy_threshold int: Health threshold for the health check. Default is 3. Range: 2–10 times.
id str: Uniquely identifies the resource.
project_name str: Project name to which the health check template belongs.
tags Sequence[GetHealthCheckTemplateTag]: List of tags associated with the health check template.
unhealthy_threshold int: Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
update_time str: Last operation time of the health check template.

createTime String: Creation time of the health check template.
description String: Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string.
healthCheckDomain String: Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks.
healthCheckHttpCode String: HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http2xx (default), http3xx (default), http4xx, http5xx.
healthCheckHttpVersion String: HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
healthCheckInterval Number: Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
healthCheckMethod String: Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
healthCheckPort Number: Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
healthCheckProtocol String: Protocol for the health check. HTTP or TCP.
healthCheckTemplateId String: Health check template ID.
healthCheckTemplateName String: Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters.
healthCheckTimeout Number: Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
healthCheckUri String: Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'.
healthyThreshold Number: Health threshold for the health check. Default is 3. Range: 2–10 times.
id String: Uniquely identifies the resource.
projectName String: Project name to which the health check template belongs.
tags List<Property Map>: List of tags associated with the health check template.
unhealthyThreshold Number: Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
updateTime String: Last operation time of the health check template.

Supporting Types

GetHealthCheckTemplateTag

Key string: Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
Value string: Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.

Key string: Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
Value string: Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.

key String: Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
value String: Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.

key string: Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
value string: Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.

key str: Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
value str: Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.

key String: Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
value String: Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.