1. Packages
  2. Volcengine
  3. API Docs
  4. alb
  5. getHealthCheckTemplates
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.alb.getHealthCheckTemplates

volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of alb health check templates

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.alb.getHealthCheckTemplates({
    ids: ["hctpl-1iidd1tobnim874adhf708uwf"],
    tags: [{
        key: "key1",
        value: "value2",
    }],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.alb.get_health_check_templates(ids=["hctpl-1iidd1tobnim874adhf708uwf"],
    tags=[volcengine.alb.GetHealthCheckTemplatesTagArgs(
        key="key1",
        value="value2",
    )])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/alb"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := alb.GetHealthCheckTemplates(ctx, &alb.GetHealthCheckTemplatesArgs{
			Ids: []string{
				"hctpl-1iidd1tobnim874adhf708uwf",
			},
			Tags: []alb.GetHealthCheckTemplatesTag{
				{
					Key:   "key1",
					Value: "value2",
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Alb.GetHealthCheckTemplates.Invoke(new()
    {
        Ids = new[]
        {
            "hctpl-1iidd1tobnim874adhf708uwf",
        },
        Tags = new[]
        {
            new Volcengine.Alb.Inputs.GetHealthCheckTemplatesTagInputArgs
            {
                Key = "key1",
                Value = "value2",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.alb.AlbFunctions;
import com.pulumi.volcengine.alb.inputs.GetHealthCheckTemplatesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = AlbFunctions.getHealthCheckTemplates(GetHealthCheckTemplatesArgs.builder()
            .ids("hctpl-1iidd1tobnim874adhf708uwf")
            .tags(GetHealthCheckTemplatesTagArgs.builder()
                .key("key1")
                .value("value2")
                .build())
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:alb:getHealthCheckTemplates
      Arguments:
        ids:
          - hctpl-1iidd1tobnim874adhf708uwf
        tags:
          - key: key1
            value: value2

    Using getHealthCheckTemplates

    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 getHealthCheckTemplates(args: GetHealthCheckTemplatesArgs, opts?: InvokeOptions): Promise<GetHealthCheckTemplatesResult>
function getHealthCheckTemplatesOutput(args: GetHealthCheckTemplatesOutputArgs, opts?: InvokeOptions): Output<GetHealthCheckTemplatesResult>
    def get_health_check_templates(health_check_template_name: Optional[str] = None,
                               ids: Optional[Sequence[str]] = None,
                               name_regex: Optional[str] = None,
                               output_file: Optional[str] = None,
                               project_name: Optional[str] = None,
                               tags: Optional[Sequence[GetHealthCheckTemplatesTag]] = None,
                               opts: Optional[InvokeOptions] = None) -> GetHealthCheckTemplatesResult
def get_health_check_templates_output(health_check_template_name: Optional[pulumi.Input[str]] = None,
                               ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               name_regex: Optional[pulumi.Input[str]] = None,
                               output_file: Optional[pulumi.Input[str]] = None,
                               project_name: Optional[pulumi.Input[str]] = None,
                               tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetHealthCheckTemplatesTagArgs]]]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetHealthCheckTemplatesResult]
    func GetHealthCheckTemplates(ctx *Context, args *GetHealthCheckTemplatesArgs, opts ...InvokeOption) (*GetHealthCheckTemplatesResult, error)
func GetHealthCheckTemplatesOutput(ctx *Context, args *GetHealthCheckTemplatesOutputArgs, opts ...InvokeOption) GetHealthCheckTemplatesResultOutput

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

    public static class GetHealthCheckTemplates 
{
    public static Task<GetHealthCheckTemplatesResult> InvokeAsync(GetHealthCheckTemplatesArgs args, InvokeOptions? opts = null)
    public static Output<GetHealthCheckTemplatesResult> Invoke(GetHealthCheckTemplatesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHealthCheckTemplatesResult> getHealthCheckTemplates(GetHealthCheckTemplatesArgs args, InvokeOptions options)
public static Output<GetHealthCheckTemplatesResult> getHealthCheckTemplates(GetHealthCheckTemplatesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:alb/getHealthCheckTemplates:getHealthCheckTemplates
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HealthCheckTemplateName string
    The name of health check template to query.
    Ids List<string>
    The list of health check templates to query.
    NameRegex string
    A Name Regex of health check template.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name to query.
    Tags List<GetHealthCheckTemplatesTag>
    Tags.
    HealthCheckTemplateName string
    The name of health check template to query.
    Ids []string
    The list of health check templates to query.
    NameRegex string
    A Name Regex of health check template.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name to query.
    Tags []GetHealthCheckTemplatesTag
    Tags.
    healthCheckTemplateName String
    The name of health check template to query.
    ids List<String>
    The list of health check templates to query.
    nameRegex String
    A Name Regex of health check template.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name to query.
    tags List<GetHealthCheckTemplatesTag>
    Tags.
    healthCheckTemplateName string
    The name of health check template to query.
    ids string[]
    The list of health check templates to query.
    nameRegex string
    A Name Regex of health check template.
    outputFile string
    File name where to save data source results.
    projectName string
    The project name to query.
    tags GetHealthCheckTemplatesTag[]
    Tags.
    health_check_template_name str
    The name of health check template to query.
    ids Sequence[str]
    The list of health check templates to query.
    name_regex str
    A Name Regex of health check template.
    output_file str
    File name where to save data source results.
    project_name str
    The project name to query.
    tags Sequence[GetHealthCheckTemplatesTag]
    Tags.
    healthCheckTemplateName String
    The name of health check template to query.
    ids List<String>
    The list of health check templates to query.
    nameRegex String
    A Name Regex of health check template.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name to query.
    tags List<Property Map>
    Tags.

    getHealthCheckTemplates Result

    The following output properties are available:

    HealthCheckTemplates List<GetHealthCheckTemplatesHealthCheckTemplate>
    The collection of health check template query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of health check template query.
    HealthCheckTemplateName string
    The name of health check template.
    Ids List<string>
    NameRegex string
    OutputFile string
    ProjectName string
    The project name to which the health check template belongs.
    Tags List<GetHealthCheckTemplatesTag>
    Tags.
    HealthCheckTemplates []GetHealthCheckTemplatesHealthCheckTemplate
    The collection of health check template query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of health check template query.
    HealthCheckTemplateName string
    The name of health check template.
    Ids []string
    NameRegex string
    OutputFile string
    ProjectName string
    The project name to which the health check template belongs.
    Tags []GetHealthCheckTemplatesTag
    Tags.
    healthCheckTemplates List<GetHealthCheckTemplatesHealthCheckTemplate>
    The collection of health check template query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of health check template query.
    healthCheckTemplateName String
    The name of health check template.
    ids List<String>
    nameRegex String
    outputFile String
    projectName String
    The project name to which the health check template belongs.
    tags List<GetHealthCheckTemplatesTag>
    Tags.
    healthCheckTemplates GetHealthCheckTemplatesHealthCheckTemplate[]
    The collection of health check template query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of health check template query.
    healthCheckTemplateName string
    The name of health check template.
    ids string[]
    nameRegex string
    outputFile string
    projectName string
    The project name to which the health check template belongs.
    tags GetHealthCheckTemplatesTag[]
    Tags.
    health_check_templates Sequence[GetHealthCheckTemplatesHealthCheckTemplate]
    The collection of health check template query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of health check template query.
    health_check_template_name str
    The name of health check template.
    ids Sequence[str]
    name_regex str
    output_file str
    project_name str
    The project name to which the health check template belongs.
    tags Sequence[GetHealthCheckTemplatesTag]
    Tags.
    healthCheckTemplates List<Property Map>
    The collection of health check template query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of health check template query.
    healthCheckTemplateName String
    The name of health check template.
    ids List<String>
    nameRegex String
    outputFile String
    projectName String
    The project name to which the health check template belongs.
    tags List<Property Map>
    Tags.

    Supporting Types

    GetHealthCheckTemplatesHealthCheckTemplate

    CreateTime string
    The creation time of the health check template.
    Description string
    The description of health check template.
    HealthCheckDomain string
    The domain name to health check.
    HealthCheckHttpCode string
    The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
    HealthCheckHttpVersion string
    The HTTP version of health check.
    HealthCheckInterval int
    The interval for performing health checks, the default value is 2, and the value is 1-300.
    HealthCheckMethod string
    The health check method, support GET and HEAD.
    HealthCheckPort int
    The port for health check. 0 means use backend server port for health check, 1-65535 means use the specified port.
    HealthCheckProtocol string
    The protocol of health check, support HTTP and TCP.
    HealthCheckTemplateId string
    The ID of health check template.
    HealthCheckTemplateName string
    The name of health check template to query.
    HealthCheckTimeout int
    The timeout of health check response,the default value is 2, and the value is 1-60.
    HealthCheckUri string
    The uri to health check,default is /.
    HealthyThreshold int
    The healthy threshold of the health check, the default is 3, the value is 2-10.
    Id string
    The id of the health check template.
    ProjectName string
    The project name to query.
    Tags List<GetHealthCheckTemplatesHealthCheckTemplateTag>
    Tags.
    UnhealthyThreshold int
    The unhealthy threshold of the health check, the default is 3, the value is 2-10.
    UpdateTime string
    The last update time of the health check template.
    CreateTime string
    The creation time of the health check template.
    Description string
    The description of health check template.
    HealthCheckDomain string
    The domain name to health check.
    HealthCheckHttpCode string
    The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
    HealthCheckHttpVersion string
    The HTTP version of health check.
    HealthCheckInterval int
    The interval for performing health checks, the default value is 2, and the value is 1-300.
    HealthCheckMethod string
    The health check method, support GET and HEAD.
    HealthCheckPort int
    The port for health check. 0 means use backend server port for health check, 1-65535 means use the specified port.
    HealthCheckProtocol string
    The protocol of health check, support HTTP and TCP.
    HealthCheckTemplateId string
    The ID of health check template.
    HealthCheckTemplateName string
    The name of health check template to query.
    HealthCheckTimeout int
    The timeout of health check response,the default value is 2, and the value is 1-60.
    HealthCheckUri string
    The uri to health check,default is /.
    HealthyThreshold int
    The healthy threshold of the health check, the default is 3, the value is 2-10.
    Id string
    The id of the health check template.
    ProjectName string
    The project name to query.
    Tags []GetHealthCheckTemplatesHealthCheckTemplateTag
    Tags.
    UnhealthyThreshold int
    The unhealthy threshold of the health check, the default is 3, the value is 2-10.
    UpdateTime string
    The last update time of the health check template.
    createTime String
    The creation time of the health check template.
    description String
    The description of health check template.
    healthCheckDomain String
    The domain name to health check.
    healthCheckHttpCode String
    The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
    healthCheckHttpVersion String
    The HTTP version of health check.
    healthCheckInterval Integer
    The interval for performing health checks, the default value is 2, and the value is 1-300.
    healthCheckMethod String
    The health check method, support GET and HEAD.
    healthCheckPort Integer
    The port for health check. 0 means use backend server port for health check, 1-65535 means use the specified port.
    healthCheckProtocol String
    The protocol of health check, support HTTP and TCP.
    healthCheckTemplateId String
    The ID of health check template.
    healthCheckTemplateName String
    The name of health check template to query.
    healthCheckTimeout Integer
    The timeout of health check response,the default value is 2, and the value is 1-60.
    healthCheckUri String
    The uri to health check,default is /.
    healthyThreshold Integer
    The healthy threshold of the health check, the default is 3, the value is 2-10.
    id String
    The id of the health check template.
    projectName String
    The project name to query.
    tags List<GetHealthCheckTemplatesHealthCheckTemplateTag>
    Tags.
    unhealthyThreshold Integer
    The unhealthy threshold of the health check, the default is 3, the value is 2-10.
    updateTime String
    The last update time of the health check template.
    createTime string
    The creation time of the health check template.
    description string
    The description of health check template.
    healthCheckDomain string
    The domain name to health check.
    healthCheckHttpCode string
    The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
    healthCheckHttpVersion string
    The HTTP version of health check.
    healthCheckInterval number
    The interval for performing health checks, the default value is 2, and the value is 1-300.
    healthCheckMethod string
    The health check method, support GET and HEAD.
    healthCheckPort number
    The port for health check. 0 means use backend server port for health check, 1-65535 means use the specified port.
    healthCheckProtocol string
    The protocol of health check, support HTTP and TCP.
    healthCheckTemplateId string
    The ID of health check template.
    healthCheckTemplateName string
    The name of health check template to query.
    healthCheckTimeout number
    The timeout of health check response,the default value is 2, and the value is 1-60.
    healthCheckUri string
    The uri to health check,default is /.
    healthyThreshold number
    The healthy threshold of the health check, the default is 3, the value is 2-10.
    id string
    The id of the health check template.
    projectName string
    The project name to query.
    tags GetHealthCheckTemplatesHealthCheckTemplateTag[]
    Tags.
    unhealthyThreshold number
    The unhealthy threshold of the health check, the default is 3, the value is 2-10.
    updateTime string
    The last update time of the health check template.
    create_time str
    The creation time of the health check template.
    description str
    The description of health check template.
    health_check_domain str
    The domain name to health check.
    health_check_http_code str
    The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
    health_check_http_version str
    The HTTP version of health check.
    health_check_interval int
    The interval for performing health checks, the default value is 2, and the value is 1-300.
    health_check_method str
    The health check method, support GET and HEAD.
    health_check_port int
    The port for health check. 0 means use backend server port for health check, 1-65535 means use the specified port.
    health_check_protocol str
    The protocol of health check, support HTTP and TCP.
    health_check_template_id str
    The ID of health check template.
    health_check_template_name str
    The name of health check template to query.
    health_check_timeout int
    The timeout of health check response,the default value is 2, and the value is 1-60.
    health_check_uri str
    The uri to health check,default is /.
    healthy_threshold int
    The healthy threshold of the health check, the default is 3, the value is 2-10.
    id str
    The id of the health check template.
    project_name str
    The project name to query.
    tags Sequence[GetHealthCheckTemplatesHealthCheckTemplateTag]
    Tags.
    unhealthy_threshold int
    The unhealthy threshold of the health check, the default is 3, the value is 2-10.
    update_time str
    The last update time of the health check template.
    createTime String
    The creation time of the health check template.
    description String
    The description of health check template.
    healthCheckDomain String
    The domain name to health check.
    healthCheckHttpCode String
    The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
    healthCheckHttpVersion String
    The HTTP version of health check.
    healthCheckInterval Number
    The interval for performing health checks, the default value is 2, and the value is 1-300.
    healthCheckMethod String
    The health check method, support GET and HEAD.
    healthCheckPort Number
    The port for health check. 0 means use backend server port for health check, 1-65535 means use the specified port.
    healthCheckProtocol String
    The protocol of health check, support HTTP and TCP.
    healthCheckTemplateId String
    The ID of health check template.
    healthCheckTemplateName String
    The name of health check template to query.
    healthCheckTimeout Number
    The timeout of health check response,the default value is 2, and the value is 1-60.
    healthCheckUri String
    The uri to health check,default is /.
    healthyThreshold Number
    The healthy threshold of the health check, the default is 3, the value is 2-10.
    id String
    The id of the health check template.
    projectName String
    The project name to query.
    tags List<Property Map>
    Tags.
    unhealthyThreshold Number
    The unhealthy threshold of the health check, the default is 3, the value is 2-10.
    updateTime String
    The last update time of the health check template.

    GetHealthCheckTemplatesHealthCheckTemplateTag

    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.

    GetHealthCheckTemplatesTag

    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
    Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate