调用UpdateHealthCheckTemplateAttribute接口修改健康检查模板。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateHealthCheckTemplateAttribute

要执行的操作。取值:UpdateHealthCheckTemplateAttribute

ClientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
HealthCheckTemplateName String HealthCheckTemplate1

健康检查模板名称。

长度为2~128个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

HealthCheckConnectPort Integer 80

健康检查使用的端口。取值范围: 0~65535

默认值:0,表示使用后端服务器的端口进行健康检查。

HealthCheckHost String $_ip

用于健康检查的域名。取值:

  • $SERVER_IP(默认值):后端服务器的私网IP。当指定了IP或该参数未指定时,负载均衡会使用后端服务器的私网IP当做健康检查使用的域名。
  • domain:域名长度为1~80字符,只能包含字母、数字、半角句号点(.)和短划线(-)。
说明 只有HealthCheckProtocol设置为HTTP时才有该参数。
HealthCheckCodes.N String http_2xx,http_3xx

健康检查正常的HTTP状态码。

  • HealthCheckProtocol取值为HTTP时,HealthCheckCodes可以选择http_2xx(默认值)、 http_3xxhttp_4xxhttp_5xx,多个状态码用半角逗号(,)分隔。
  • HealthCheckProtocol取值为gRPC时,HealthCheckCodes状态码范围:0~99,默认值:0。支持范围输入,最多支持20个范围值,多个范围值使用半角逗号(,)隔开。
说明 只有HealthCheckProtocolHTTPgRPC时才有该参数。
HealthCheckInterval Integer 5

健康检查的时间间隔。单位:秒。取值范围:1~50。默认值:2秒。

HealthCheckTimeout Integer 3

接收来自运行状况检查的响应需要等待的时间。如果后端服务器在指定的时间内没有正确响应,则判定为健康检查失败。

单位:秒。取值范围:1~300。默认值:5秒。

说明 如果HealthCHeckTimeout的值小于HealthCheckInterval的值,则HealthCHeckTimeout无效,超时时间为HealthCheckInterval的值。
HealthCheckPath String /test/index.html

用于健康检查的URL。

长度限制为1~80,只能使用字母、数字和短划线(-)、正斜线(/)、半角句号点(.)、百分号(%)、半角问号(?)、井号(#)、and(&)这些字符以及扩展字符集_;~!()*[]@$^:',+

URL必须以正斜线(/)开头。

说明 只有HealthCheckProtocolHTTPgRPC时才有该参数。
HealthCheckMethod String HEAD

健康检查方法。取值:

  • HEAD(默认值):HTTP监听健康检查默认采用HEAD方法。
  • GET:如果响应报文长度超过8K,会被截断,但不会影响健康检查结果的判定。
  • POST:gRPC监听健康检查默认采用POST方法。
说明 只有HealthCheckProtocolHTTPgRPC时才有该参数。
HealthCheckProtocol String HTTP

健康检查采用的协议。取值:

  • HTTP(默认值):通过发送HEAD或GET请求模拟浏览器的访问行为来检查服务器应用是否健康。
  • TCP:通过发送SYN握手报文来检测服务器端口是否存活。
  • gRPC:通过发送POST或GET请求来检查服务器应用是否健康。
HealthCheckHttpVersion String HTTP1.0

健康检查HTTP协议版本。

取值:HTTP1.0HTTP1.1

默认值:HTTP1.1

说明 只有HealthCheckProtocolHTTP时才有该参数。
HealthyThreshold Integer 4

健康检查连续成功多少次后,将后端服务器的健康检查状态由失败判定为成功

取值范围:2~10

默认值:3

UnhealthyThreshold Integer 4

健康检查连续失败多少次后,将后端服务器的健康检查状态由成功判定为失败

取值范围:2~10

默认值:3

DryRun Boolean true

是否只预检此次请求,取值:

  • true:发送检查请求,不会修改资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回http_2xx状态码并直接进行操作。
HealthCheckTemplateId String hct-bp1qjwo61pqz3ahltv0mw

模板ID。

返回数据

名称 类型 示例值 描述
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateHealthCheckTemplateAttribute
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&HealthCheckTemplateName=HealthCheckTemplate1
&HealthCheckConnectPort=80
&HealthCheckHost=$_ip
&HealthCheckCodes=["http_2xx,http_3xx"]
&HealthCheckInterval=5
&HealthCheckTimeout=3
&HealthCheckPath=/test/index.html
&HealthCheckMethod=HEAD
&HealthCheckProtocol=HTTP
&HealthCheckHttpVersion=HTTP1.0
&HealthyThreshold=4
&UnhealthyThreshold=4
&DryRun=true
&HealthCheckTemplateId=hct-bp1qjwo61pqz3ahltv0mw
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateHealthCheckTemplateAttributeResponse>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
</UpdateHealthCheckTemplateAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectStatus.HealthCheckTemplate The status of %s [%s] is incorrect. 资源%s [%s]的状态无效。
404 ResourceNotFound.HealthCheckTemplate The specified resource %s is not found. 资源%s不存在。

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