bytepluscc.alb.getHealthCheckTemplate

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

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: bytepluscc: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: 健康检查模版的创建时间。
Description string: 健康检查描述。不能以http://或https://开头。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ～ 255个字符。不填默认为空字符串。
HealthCheckDomain string: 健康检查的域名。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：需至少包含一个‘.’，且不允许以‘.’开头结尾。单个字符串由字母、数字、‘-’、‘.’字符组成，‘-’不得出现在字符串的头部或尾部。长度限制为1 ～ 128个字符。不填则此参数为空，负载均衡默认使用各后端服务器的私网IP地址进行健康检查。
HealthCheckHttpCode string: 健康检查正常的HTTP状态码。多个状态码用以半角逗号分隔，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：http2xx（默认）。http3xx（默认）。http4xx 。http5xx 。
HealthCheckHttpVersion string: 健康检查HTTP协议版本。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：HTTP1.0（默认值）。HTTP1.1。
HealthCheckInterval int: 执行健康检查的时间间隔，默认为2，取值1-300s 。
HealthCheckMethod string: 健康检查的方法。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：GETHEAD（默认方法）
HealthCheckPort int: 健康检查端口。取值如下：0：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
HealthCheckProtocol string: 健康检查的协议。HTTPTCP。
HealthCheckTemplateId string: 健康检查模板 ID。
HealthCheckTemplateName string: 健康检查模板的名称。不能以http://或https://开头。必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。长度限制在1～128字符之间。
HealthCheckTimeout int: 健康检查的响应超时时间，默认为2，取值1-60s 。
HealthCheckUri string: 健康检查的路径。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’字符。长度限制为1 ～ 128个字符。不填默认为“/”。
HealthyThreshold int: 健康检查的健康阈值，默认为3，取值2-10次。
Id string: Uniquely identifies the resource.
ProjectName string: 健康检查模板所属项目名称。
Tags List<Byteplus.GetHealthCheckTemplateTag>: 健康检查模板关联的标签列表。
UnhealthyThreshold int: 健康检查的不健康阈值，默认为3，取值2-10次。
UpdateTime string: 健康检查模版最近一次的操作时间。

CreateTime string: 健康检查模版的创建时间。
Description string: 健康检查描述。不能以http://或https://开头。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ～ 255个字符。不填默认为空字符串。
HealthCheckDomain string: 健康检查的域名。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：需至少包含一个‘.’，且不允许以‘.’开头结尾。单个字符串由字母、数字、‘-’、‘.’字符组成，‘-’不得出现在字符串的头部或尾部。长度限制为1 ～ 128个字符。不填则此参数为空，负载均衡默认使用各后端服务器的私网IP地址进行健康检查。
HealthCheckHttpCode string: 健康检查正常的HTTP状态码。多个状态码用以半角逗号分隔，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：http2xx（默认）。http3xx（默认）。http4xx 。http5xx 。
HealthCheckHttpVersion string: 健康检查HTTP协议版本。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：HTTP1.0（默认值）。HTTP1.1。
HealthCheckInterval int: 执行健康检查的时间间隔，默认为2，取值1-300s 。
HealthCheckMethod string: 健康检查的方法。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：GETHEAD（默认方法）
HealthCheckPort int: 健康检查端口。取值如下：0：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
HealthCheckProtocol string: 健康检查的协议。HTTPTCP。
HealthCheckTemplateId string: 健康检查模板 ID。
HealthCheckTemplateName string: 健康检查模板的名称。不能以http://或https://开头。必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。长度限制在1～128字符之间。
HealthCheckTimeout int: 健康检查的响应超时时间，默认为2，取值1-60s 。
HealthCheckUri string: 健康检查的路径。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’字符。长度限制为1 ～ 128个字符。不填默认为“/”。
HealthyThreshold int: 健康检查的健康阈值，默认为3，取值2-10次。
Id string: Uniquely identifies the resource.
ProjectName string: 健康检查模板所属项目名称。
Tags []GetHealthCheckTemplateTag: 健康检查模板关联的标签列表。
UnhealthyThreshold int: 健康检查的不健康阈值，默认为3，取值2-10次。
UpdateTime string: 健康检查模版最近一次的操作时间。

createTime String: 健康检查模版的创建时间。
description String: 健康检查描述。不能以http://或https://开头。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ～ 255个字符。不填默认为空字符串。
healthCheckDomain String: 健康检查的域名。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：需至少包含一个‘.’，且不允许以‘.’开头结尾。单个字符串由字母、数字、‘-’、‘.’字符组成，‘-’不得出现在字符串的头部或尾部。长度限制为1 ～ 128个字符。不填则此参数为空，负载均衡默认使用各后端服务器的私网IP地址进行健康检查。
healthCheckHttpCode String: 健康检查正常的HTTP状态码。多个状态码用以半角逗号分隔，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：http2xx（默认）。http3xx（默认）。http4xx 。http5xx 。
healthCheckHttpVersion String: 健康检查HTTP协议版本。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：HTTP1.0（默认值）。HTTP1.1。
healthCheckInterval Integer: 执行健康检查的时间间隔，默认为2，取值1-300s 。
healthCheckMethod String: 健康检查的方法。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：GETHEAD（默认方法）
healthCheckPort Integer: 健康检查端口。取值如下：0：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
healthCheckProtocol String: 健康检查的协议。HTTPTCP。
healthCheckTemplateId String: 健康检查模板 ID。
healthCheckTemplateName String: 健康检查模板的名称。不能以http://或https://开头。必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。长度限制在1～128字符之间。
healthCheckTimeout Integer: 健康检查的响应超时时间，默认为2，取值1-60s 。
healthCheckUri String: 健康检查的路径。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’字符。长度限制为1 ～ 128个字符。不填默认为“/”。
healthyThreshold Integer: 健康检查的健康阈值，默认为3，取值2-10次。
id String: Uniquely identifies the resource.
projectName String: 健康检查模板所属项目名称。
tags List<GetHealthCheckTemplateTag>: 健康检查模板关联的标签列表。
unhealthyThreshold Integer: 健康检查的不健康阈值，默认为3，取值2-10次。
updateTime String: 健康检查模版最近一次的操作时间。

createTime string: 健康检查模版的创建时间。
description string: 健康检查描述。不能以http://或https://开头。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ～ 255个字符。不填默认为空字符串。
healthCheckDomain string: 健康检查的域名。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：需至少包含一个‘.’，且不允许以‘.’开头结尾。单个字符串由字母、数字、‘-’、‘.’字符组成，‘-’不得出现在字符串的头部或尾部。长度限制为1 ～ 128个字符。不填则此参数为空，负载均衡默认使用各后端服务器的私网IP地址进行健康检查。
healthCheckHttpCode string: 健康检查正常的HTTP状态码。多个状态码用以半角逗号分隔，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：http2xx（默认）。http3xx（默认）。http4xx 。http5xx 。
healthCheckHttpVersion string: 健康检查HTTP协议版本。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：HTTP1.0（默认值）。HTTP1.1。
healthCheckInterval number: 执行健康检查的时间间隔，默认为2，取值1-300s 。
healthCheckMethod string: 健康检查的方法。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：GETHEAD（默认方法）
healthCheckPort number: 健康检查端口。取值如下：0：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
healthCheckProtocol string: 健康检查的协议。HTTPTCP。
healthCheckTemplateId string: 健康检查模板 ID。
healthCheckTemplateName string: 健康检查模板的名称。不能以http://或https://开头。必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。长度限制在1～128字符之间。
healthCheckTimeout number: 健康检查的响应超时时间，默认为2，取值1-60s 。
healthCheckUri string: 健康检查的路径。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’字符。长度限制为1 ～ 128个字符。不填默认为“/”。
healthyThreshold number: 健康检查的健康阈值，默认为3，取值2-10次。
id string: Uniquely identifies the resource.
projectName string: 健康检查模板所属项目名称。
tags GetHealthCheckTemplateTag[]: 健康检查模板关联的标签列表。
unhealthyThreshold number: 健康检查的不健康阈值，默认为3，取值2-10次。
updateTime string: 健康检查模版最近一次的操作时间。

create_time str: 健康检查模版的创建时间。
description str: 健康检查描述。不能以http://或https://开头。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ～ 255个字符。不填默认为空字符串。
health_check_domain str: 健康检查的域名。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：需至少包含一个‘.’，且不允许以‘.’开头结尾。单个字符串由字母、数字、‘-’、‘.’字符组成，‘-’不得出现在字符串的头部或尾部。长度限制为1 ～ 128个字符。不填则此参数为空，负载均衡默认使用各后端服务器的私网IP地址进行健康检查。
health_check_http_code str: 健康检查正常的HTTP状态码。多个状态码用以半角逗号分隔，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：http2xx（默认）。http3xx（默认）。http4xx 。http5xx 。
health_check_http_version str: 健康检查HTTP协议版本。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：HTTP1.0（默认值）。HTTP1.1。
health_check_interval int: 执行健康检查的时间间隔，默认为2，取值1-300s 。
health_check_method str: 健康检查的方法。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：GETHEAD（默认方法）
health_check_port int: 健康检查端口。取值如下：0：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
health_check_protocol str: 健康检查的协议。HTTPTCP。
health_check_template_id str: 健康检查模板 ID。
health_check_template_name str: 健康检查模板的名称。不能以http://或https://开头。必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。长度限制在1～128字符之间。
health_check_timeout int: 健康检查的响应超时时间，默认为2，取值1-60s 。
health_check_uri str: 健康检查的路径。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’字符。长度限制为1 ～ 128个字符。不填默认为“/”。
healthy_threshold int: 健康检查的健康阈值，默认为3，取值2-10次。
id str: Uniquely identifies the resource.
project_name str: 健康检查模板所属项目名称。
tags Sequence[GetHealthCheckTemplateTag]: 健康检查模板关联的标签列表。
unhealthy_threshold int: 健康检查的不健康阈值，默认为3，取值2-10次。
update_time str: 健康检查模版最近一次的操作时间。

createTime String: 健康检查模版的创建时间。
description String: 健康检查描述。不能以http://或https://开头。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为1 ～ 255个字符。不填默认为空字符串。
healthCheckDomain String: 健康检查的域名。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：需至少包含一个‘.’，且不允许以‘.’开头结尾。单个字符串由字母、数字、‘-’、‘.’字符组成，‘-’不得出现在字符串的头部或尾部。长度限制为1 ～ 128个字符。不填则此参数为空，负载均衡默认使用各后端服务器的私网IP地址进行健康检查。
healthCheckHttpCode String: 健康检查正常的HTTP状态码。多个状态码用以半角逗号分隔，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：http2xx（默认）。http3xx（默认）。http4xx 。http5xx 。
healthCheckHttpVersion String: 健康检查HTTP协议版本。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：HTTP1.0（默认值）。HTTP1.1。
healthCheckInterval Number: 执行健康检查的时间间隔，默认为2，取值1-300s 。
healthCheckMethod String: 健康检查的方法。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值如下：GETHEAD（默认方法）
healthCheckPort Number: 健康检查端口。取值如下：0：使用后端服务器端口进行健康检查。1-65535：使用您指定的端口进行健康检查。
healthCheckProtocol String: 健康检查的协议。HTTPTCP。
healthCheckTemplateId String: 健康检查模板 ID。
healthCheckTemplateName String: 健康检查模板的名称。不能以http://或https://开头。必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。长度限制在1～128字符之间。
healthCheckTimeout Number: 健康检查的响应超时时间，默认为2，取值1-60s 。
healthCheckUri String: 健康检查的路径。只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：必须以字符‘/’开头。仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’字符。长度限制为1 ～ 128个字符。不填默认为“/”。
healthyThreshold Number: 健康检查的健康阈值，默认为3，取值2-10次。
id String: Uniquely identifies the resource.
projectName String: 健康检查模板所属项目名称。
tags List<Property Map>: 健康检查模板关联的标签列表。
unhealthyThreshold Number: 健康检查的不健康阈值，默认为3，取值2-10次。
updateTime String: 健康检查模版最近一次的操作时间。

Supporting Types

GetHealthCheckTemplateTag

Key string: 用户标签的标签键。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以sys:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。
Value string: 用户标签的标签值。如果传入该参数，则必须先传入Tags.N.Key。具体规则如下：长度限制为0～256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

Key string: 用户标签的标签键。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以sys:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。
Value string: 用户标签的标签值。如果传入该参数，则必须先传入Tags.N.Key。具体规则如下：长度限制为0～256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

key String: 用户标签的标签键。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以sys:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。
value String: 用户标签的标签值。如果传入该参数，则必须先传入Tags.N.Key。具体规则如下：长度限制为0～256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

key string: 用户标签的标签键。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以sys:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。
value string: 用户标签的标签值。如果传入该参数，则必须先传入Tags.N.Key。具体规则如下：长度限制为0～256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

key str: 用户标签的标签键。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以sys:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。
value str: 用户标签的标签值。如果传入该参数，则必须先传入Tags.N.Key。具体规则如下：长度限制为0～256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

key String: 用户标签的标签键。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以sys:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。
value String: 用户标签的标签值。如果传入该参数，则必须先传入Tags.N.Key。具体规则如下：长度限制为0～256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。