使用CreateHealthCheckTemplate创建健康检查模板-负载均衡-阿里云-负载均衡(SLB)-阿里云帮助中心

在指定地域创建健康检查模板。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alb:CreateHealthCheckTemplate

create

*HealthCheckTemplate

acs:alb:{#regionId}:{#accountId}:healthchecktemplate/*

无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	5A2CFF0E-5718-45B5-9D4D-70B******
HealthCheckTemplateName	string	是	健康检查模板名称。长度为 2~128 个英文或中文字符，必须以字母、中文或数字开头，可包含数字、半角句号（.）、下划线（_）、短划线（-）和空格。	HealthCheckTemplate1
HealthCheckConnectPort	integer	否	健康检查使用的端口。取值范围：0~65535。默认值：0，表示使用后端服务器的端口进行健康检查。	80
HealthCheckHost	string	否	用于健康检查的域名。取值： $SERVER_IP：后端服务器的私网 IP。当指定了 IP 或该参数未指定时，负载均衡会使用后端服务器的私网 IP 当做健康检查使用的域名。 domain：域名长度为 1~80 字符，只能包含字母、数字、半角句号（.）和短划线（-）。说明只有`HealthCheckProtocol`设置为 HTTP 或 HTTPS 时该参数生效。	$SERVER_IP
HealthCheckCodes	array	否	健康检查正常的状态码列表。	5
	string	否	健康检查正常的 HTTP 状态码。当 HealthCheckProtocol 取值为 HTTP 或 HTTPS 时，HealthCheckCodes 可以选择http_2xx（默认值）、 http_3xx、http_4xx和http_5xx，多个状态码用半角逗号（,）分隔。当 HealthCheckProtocol 取值为 gRPC 时，HealthCheckCodes 状态码范围：0~99，默认值：0。支持范围输入，最多支持 20 个范围值，多个范围值使用半角逗号（,）隔开。说明只有 HealthCheckProtocol 为 HTTP 或 HTTPS 或 gRPC 时才有该参数。	http_2xx
HealthCheckInterval	integer	否	健康检查的时间间隔。取值范围：1~50秒。默认值：2 秒。	2
HealthCheckTimeout	integer	否	接收来自运行状况检查的响应需要等待的时间。如果后端服务器在指定的时间内没有正确响应，则判定为健康检查失败。取值范围：1~300秒。默认值：5 秒。	5
HealthCheckPath	string	否	用于健康检查的 URL。长度限制为 1~80，支持使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和 and（&）以及扩展字符集`_;~!（)[]@$^:',+`。URL 必须以正斜线（/）开头。说明只有`HealthCheckProtocol`为 HTTP* 或 HTTPS 时才有该参数。	/test/index.html
HealthCheckMethod	string	否	健康检查方法。取值： HEAD（默认值）：HTTP 和 HTTPS 监听健康检查默认采用 HEAD 方法。 POST：gRPC 监听健康检查默认采用 POST 方法。 GET：如果响应报文长度超过 8KB，会被截断，但不会影响健康检查结果的判定。说明只有 HealthCheckProtocol 为 HTTP 或 HTTPS 或 gRPC 时才有该参数。	HEAD
HealthCheckProtocol	string	否	健康检查采用的协议。取值： HTTP（默认值）：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。 HTTPS：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。（数据加密，相比 HTTP 更安全。） TCP：通过发送 SYN 握手报文来检测服务器端口是否存活。 gRPC：通过发送 POST 或 GET 请求来检查服务器应用是否健康。	HTTP
HealthCheckHttpVersion	string	否	健康检查 HTTP 协议版本。取值：HTTP 1.0或HTTP 1.1。默认值：HTTP 1.1。说明只有`HealthCheckProtocol`为 HTTP 或 HTTPS 时才有该参数。	HTTP 1.0
HealthyThreshold	integer	否	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值范围：2~10。默认值：3。	4
UnhealthyThreshold	integer	否	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值范围：2~10。默认值：3。	4
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回http_2xx状态码并直接进行操作。	true
Tag	array<object>	否	标签。
	object	否	标签结构。
Key	string	否	标签键。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。	env
Value	string	否	标签值。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。	product
ResourceGroupId	string	否	资源组 ID	rg-atstuj3rtop****

返回参数

名称	类型	描述	示例值
	object	健康检查模板。
HealthCheckTemplateId	string	健康检查模板 ID。	hct-pno8sisi******
RequestId	string	请求 ID。	365F4154-92F6-4AE4-92F8-7FF34******

示例

正常返回示例

JSON格式

{
  "HealthCheckTemplateId": "hct-pno8sisi******",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}

错误码

HTTP status code	错误码	错误信息	描述
400	QuotaExceeded.HealthCheckTemplatesNum	The quota of %s is exceeded, usage %s/%s.	配额%s已超额度限制，目前已使用%s，配额为%s。
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.	对HealthCheckTemplate鉴权失败

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。