应用型负载均衡查询健康检查模板列表

1. 接口描述

接口请求域名： alb.tencentcloudapi.com 。

查询健康检查模板列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeHealthCheckTemplates。
Version	是	String	公共参数，本接口取值：2025-10-30。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	过滤器。通过指定的过滤条件来查询健康检查模板，支持： Name的值为HealthCheckTemplateName。通过名称来筛选健康检查模板。Values的值为模板名称列表。 Name的值为HealthCheckProtocol。通过健康检查协议来筛选健康检查模板。Values的值为协议列表。通过标签方式筛选。
HealthCheckTemplateIds.N	否	Array of String	健康检查模板 ID 列表，ID 格式为 hct- 后接字母数字。示例值：["hct-m4x8q2pa"]
MaxResults	否	String	返回列表的数量，默认为20，最大值为100。示例值：20
NextToken	否	String	下一次查询的Token值。第一次查询和没有下一次查询时，无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。示例值：3974ae26e***

3. 输出参数

参数名称	类型	描述
HealthCheckTemplates	Array of HealthCheckTemplate	健康检查模板列表。
NextToken	String	下一次查询的Token值，如果当前是最后一页，返回为空。示例值：3974ae26e***
TotalCount	Integer	经过筛选后查询到的健康检查模板总数。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询健康检查模板列表

输入示例

POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHealthCheckTemplates
<公共请求参数>

{
    "HealthCheckTemplateIds": [
        "hct-m4x8q2pa"
    ],
    "MaxResults": "20"
}

输出示例

{
    "Response": {
        "HealthCheckTemplates": [
            {
                "HealthCheckCodes": [
                    "http_1xx"
                ],
                "HealthCheckHealthyThreshold": 2,
                "HealthCheckHost": "example.com",
                "HealthCheckHttpVersion": "HTTP1.1",
                "HealthCheckInterval": 10,
                "HealthCheckMethod": "GET",
                "HealthCheckPath": "/hello/index.html",
                "HealthCheckPort": 80,
                "HealthCheckProtocol": "HTTP",
                "HealthCheckTemplateId": "hct-m4x8q2pa",
                "HealthCheckTemplateName": "target-group-health-check",
                "CreateTime": "2025-01-01T08:30:00+08:00",
                "ModifyTime": "2025-01-01T08:30:00+08:00",
                "HealthCheckTimeout": 2,
                "HealthCheckUnhealthyThreshold": 2,
                "Tags": [
                    {
                        "TagKey": "key-xxx",
                        "TagValue": "value-xxx"
                    }
                ]
            }
        ],
        "NextToken": "3974ae26e***",
        "TotalCount": 1,
        "RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。