ListHealthCheckTemplates - 查询健康检查模板 - 负载均衡

查询指定地域的健康检查模板。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
alb:ListHealthCheckTemplates	list	HealthCheckTemplate acs:alb:{#regionId}:{#accountId}:healthchecktemplate/*	无	无

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。	50
HealthCheckTemplateIds	array	否	健康检查模版 ID 列表。
	string	否	健康检查模版 ID。最多支持 20 个健康检查模板 ID。如果传入则根据模板 ID 过滤。	hct-bp1qjwo61pqz3ahltv****
HealthCheckTemplateNames	array	否	健康检查模板名称列表。
	string	否	健康检查模版名称。最多支持 10 个健康检查模板名称。如果传入则根据模板名称过滤。	test
Tag	array<object>	否	标签。
	object	否	标签结构。
Key	string	否	标签键。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	env
Value	string	否	标签值。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	product

返回参数

名称	类型	描述	示例值
	object	健康检查模板信息。
HealthCheckTemplates	array<object>	健康检查模板列表。
	object	健康检查模板结构。
HealthCheckConnectPort	integer	健康检查使用的端口。取值： 0~65535。默认值：0，表示使用后端服务器的端口进行健康检查。	80
HealthCheckHost	string	用于健康检查的域名，取值： $SERVER_IP（默认值）：后端服务器的私网 IP。当指定了 IP 或该参数未指定时，负载均衡会使用各后端服务器的私网 IP 当做健康检查使用的域名。 domain：域名长度为 1~80 字符，只能包含字母、数字、半角句号（.）和短划线（-）。说明只有`HealthCheckProtocol`为 HTTP 或 HTTPS 时才有效。	$SERVER_IP
HealthCheckCodes	array	健康检查正常的状态码列表。
	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
HealthCheckHttpVersion	string	健康检查 HTTP 协议版本。取值：HTTP 1.0或HTTP 1.1。默认值：HTTP 1.1。说明只有`HealthCheckProtocol`为 HTTP 或 HTTPS 时才有效。	HTTP 1.0
HealthCheckInterval	integer	健康检查的时间间隔。单位：秒。取值范围：1~50。默认值：2 秒。	5
HealthCheckMethod	string	健康检查方法。取值： HEAD（默认值）：HTTP 和 HTTPS 监听健康检查默认采用 HEAD 方法。 GET：如果响应报文长度超过 8K，会被截断，但不会影响健康检查结果的判定。 POST：gRPC 监听健康检查默认采用 POST 方法。说明只有 HealthCheckProtocol 为 HTTP 或 HTTPS 或 gRPC 时才有效。	HEAD
HealthCheckPath	string	用于健康检查的 URL。长度限制为 1~80，只能使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）、and（&）这些字符以及扩展字符集`_;~!（)*[]@$^:',+`。URL 必须以正斜线（/）开头。	/test/index.html
HealthCheckProtocol	string	健康检查采用的协议。取值： HTTP（默认值）：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。 HTTPS：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。（数据加密，相比 HTTP 更安全。） TCP：通过发送 SYN 握手报文来检测服务器端口是否存活。 gRPC：通过发送 POST 或 GET 请求来检查服务器应用是否健康。	HTTP
HealthCheckTemplateId	string	健康检查模板 ID。	hct-bp1qjwo61pqz3ahltv****
HealthCheckTemplateName	string	健康检查模板名称。长度为 2~128 个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	HealthCheckTemplate1
HealthCheckTimeout	integer	接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有正确响应，则判定为健康检查失败。取值：1~300秒。默认值：5 秒。	3
HealthyThreshold	integer	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值：2~10。默认值：3。	4
UnhealthyThreshold	integer	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值：2~10。默认值：3。	4
Tags	array<object>	标签。
	object	标签结构。
Key	string	标签键。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	env
Value	string	标签值。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	product
MaxResults	integer	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。	50
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	请求 ID。	365F4154-92F6-4AE4-92F8-7FF3******
TotalCount	integer	本次请求条件下返回的总数据记录数。	1000

示例

正常返回示例

JSON格式

{
  "HealthCheckTemplates": [
    {
      "HealthCheckConnectPort": 80,
      "HealthCheckHost": "$SERVER_IP",
      "HealthCheckCodes": [
        "http_2xx"
      ],
      "HealthCheckHttpVersion": "HTTP 1.0",
      "HealthCheckInterval": 5,
      "HealthCheckMethod": "HEAD",
      "HealthCheckPath": "/test/index.html",
      "HealthCheckProtocol": "HTTP",
      "HealthCheckTemplateId": "hct-bp1qjwo61pqz3ahltv****",
      "HealthCheckTemplateName": "HealthCheckTemplate1",
      "HealthCheckTimeout": 3,
      "HealthyThreshold": 4,
      "UnhealthyThreshold": 4,
      "Tags": [
        {
          "Key": "env",
          "Value": "product"
        }
      ]
    }
  ],
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******",
  "TotalCount": 1000
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.	对HealthCheckTemplate鉴权失败

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

变更历史

变更时间	变更内容概要	操作
2024-01-17	OpenAPI 错误码发生变更	查看变更详情