调用GetHealthCheckTemplateAttribute查询健康检查模板详细信息

查询指定健康检查模板详细信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
HealthCheckTemplateId	string	是	健康检查模板 ID。	hct-x4jazoyi6tvsq9****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
HealthCheckConnectPort	integer	健康检查使用的端口。取值范围： 0~65535。	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 协议版本。取值：HTTP1.0或HTTP1.1。说明只有`HealthCheckProtocol`为 HTTP 或 HTTPS 时该参数生效。	HTTP1.0
HealthCheckTemplateId	string	健康检查模板 ID。	hct-x4jazoyi6tvsq9****
HealthCheckInterval	integer	健康检查的时间间隔。单位：秒。取值范围：1~50。	3
HealthCheckMethod	string	健康检查方法。取值： HEAD（默认值）：HTTP 和 HTTPS 监听健康检查默认采用 HEAD 方法。 GET：如果响应报文长度超过 8K，会被截断，但不会影响健康检查结果的判定。 POST：gRPC 监听健康检查默认采用 POST 方法。说明只有 HealthCheckProtocol 为 HTTP 或 HTTPS 或 gRPC 时该参数生效。	GET
HealthCheckPath	string	用于健康检查的 URL。长度限制为 1~80，只能使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）、and（&）这些字符以及扩展字符集`_;~!（)[]@$^:',+`。 URL 必须以正斜线（/）开头。说明只有 HealthCheckProtocol* 为 HTTP 或 HTTPS 或 gRPC 时该参数生效。	/test/index.html
HealthCheckProtocol	string	健康检查采用的协议。取值： HTTP（默认值）：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。 HTTPS：通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。（数据加密，相比 HTTP 更安全。） TCP：通过发送 SYN 握手报文来检测服务器端口是否存活。 gRPC：通过发送 POST 或 GET 请求来检查服务器应用是否健康。	HTTP
HealthCheckTemplateName	string	健康检查模板名称。长度为 2~128 个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	HealthCheckTemplate1
HealthCheckTimeout	integer	接收来自运行状况检查的响应需要等待的时间。如果后端服务器在指定的时间内没有正确响应，则判定为健康检查失败。单位：秒。取值范围：1~300。	200
HealthyThreshold	integer	健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值范围：2~10。	5
RequestId	string	请求 ID。	DB1AFC33-DAE8-528E-AA4D-4A6A******
UnhealthyThreshold	integer	健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值范围：2~10。	5
Tags	array<object>	标签。
	object	标签结构。
Key	string	标签键。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	env
Value	string	标签值。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	product

示例

正常返回示例

JSON格式

{
  "HealthCheckConnectPort": 80,
  "HealthCheckHost": "$SERVER_IP",
  "HealthCheckCodes": [
    "http_2xx"
  ],
  "HealthCheckHttpVersion": "HTTP1.0",
  "HealthCheckTemplateId": "hct-x4jazoyi6tvsq9****",
  "HealthCheckInterval": 3,
  "HealthCheckMethod": "GET",
  "HealthCheckPath": "/test/index.html",
  "HealthCheckProtocol": "HTTP",
  "HealthCheckTemplateName": "HealthCheckTemplate1",
  "HealthCheckTimeout": 200,
  "HealthyThreshold": 5,
  "RequestId": "DB1AFC33-DAE8-528E-AA4D-4A6A******",
  "UnhealthyThreshold": 5,
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.	对HealthCheckTemplate鉴权失败
404	ResourceNotFound.HealthCheckTemplate	The specified resource %s is not found.	资源%s不存在。

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

变更历史

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