应用型负载均衡创建健康检查模板

1. 接口描述

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

创建健康检查模板

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateHealthCheckTemplate。
Version	是	String	公共参数，本接口取值：2025-10-30。
Region	是	String	公共参数，详见产品支持的地域列表。
DryRun	否	Boolean	是否预览此次请求。 - false（默认）：发送普通请求，直接修改健康检查模板。 - true：发送预览请求，检查修改健康检查模板的参数、格式、业务限制等是否符合要求。示例值：true
HealthCheckCodes.N	否	Array of String	健康检查状态码。取值： - 当健康检查协议为HTTP/HTTPS时： - http_1xx - http_2xx（默认值） - http_3xx - http_4xx - http_5xx - 当健康检查协议为GRPC/GRPCS时：默认值为12，数值范围为0-99，输入值可为数值、多个数值或者范围以及相互组合，如： - "20" - "0-99" 示例值：["http_1xx"]
HealthCheckHealthyThreshold	否	Integer	判定后端服务健康的阈值，当健康检查连续成功多少次后，后端服务的状态由不健康变为健康。取值范围：2-10。默认值：2。示例值：2
HealthCheckHost	否	String	健康检查域名。长度限制为 1-255 个字符。可包含小写字母、数字、短划线（-）和半角句号（.）。 > 仅当 HealthCheckProtocol 设置为 HTTP/HTTPS/GRPC/GRPCS 时，该参数生效。示例值：example.com
HealthCheckHttpVersion	否	String	健康检查 HTTP 协议版本，取值： - HTTP1.1（默认） - HTTP1.0 > 仅当HealthCheckProtocol设置为HTTP 或 HTTPS 时，该参数生效。示例值：HTTP1.1
HealthCheckInterval	否	Integer	健康检查的时间间隔。单位：秒。取值范围：2-300。默认值：5。示例值：10
HealthCheckMethod	否	String	健康检查方法，取值： - GET - HEAD（默认值） > 仅当HealthCheckProtocol设置为HTTP 或 HTTPS 时，该参数生效。示例值：GET
HealthCheckPath	否	String	健康检查的转发规则路径。长度为 1-80 个字符，只能使用字母、数字、字符`-/.%?#&=`以及扩展字符`_;~!（)[]@$^:',+`。 URL 必须以正斜线（/）开头。 > 仅当HealthCheckProtocol为HTTP/HTTPS/GRPC/GRPCS*时，转发规则路径参数生效。示例值：/hello/index.html
HealthCheckPort	否	Integer	健康检查访问后端服务器的端口。取值范围：0-65535。默认值：0，表示后端服务器的端口。示例值：80
HealthCheckProtocol	否	String	健康检查协议。取值： - HTTP（默认）：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。 - HTTPS：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。（数据加密，相比 HTTP 更安全。） - TCP：通过发送 SYN 握手报文来检测服务器端口是否存活。 - GRPC：通过发送 POST 或 GET 请求来检查服务器应用是否健康。 - GRPCS：通过发送 POST 或 GET 请求来检查服务器应用是否健康。示例值：HTTP
HealthCheckTemplateName	否	String	健康检查模板名称。长度为 1-255 个字符，可包含数字、大小写字母、中文、半角句号（.）、下划线（_）和短划线（-）。示例值：lbtg-0zrnc9qa-template
HealthCheckTimeout	否	Integer	健康检查的响应超时时间。单位：秒。取值范围：2-60。默认值：2。示例值：2
HealthCheckUnhealthyThreshold	否	Integer	判定后端服务不健康的阈值，当健康检查连续失败多少次后，后端服务的状态由健康变为不健康。取值范围：2-10。默认值：2。示例值：2
Tags.N	否	Array of TagInfo	标签。

3. 输出参数

参数名称	类型	描述
HealthCheckTemplateId	String	健康检查模板 ID，格式为 hct- 后接字母数字。所有接口（创建、查询、修改、删除）均使用 hct- 前缀。示例值：hct-m4x8q2pa
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建健康检查模板

输入示例

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

{
    "HealthCheckCodes": [
        "http_1xx"
    ],
    "HealthCheckHealthyThreshold": 2,
    "HealthCheckHost": "example.com",
    "HealthCheckHttpVersion": "HTTP1.1",
    "HealthCheckInterval": 10,
    "HealthCheckMethod": "GET",
    "HealthCheckPath": "/hello/index.html",
    "HealthCheckPort": 80,
    "HealthCheckProtocol": "HTTP",
    "HealthCheckTemplateName": "lbtg-0zrnc9qa-template",
    "HealthCheckTimeout": 2,
    "HealthCheckUnhealthyThreshold": 2,
    "Tags": [
        {
            "TagKey": "key-xxx",
            "TagValue": "value-xxx"
        }
    ]
}

输出示例

{
    "Response": {
        "HealthCheckTemplateId": "hct-m4x8q2pa",
        "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. 错误码

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