调用CreateHealthCheckTemplate创建健康检查模板。

调试

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

请求参数

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

要执行的操作。

取值:CreateHealthCheckTemplate

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

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

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

健康检查模板名称。

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

HealthCheckConnectPort Integer 80

健康检查使用的端口。

取值:0~65535

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

HealthCheckHost String $_ip

用于健康检查的域名。

默认值为$SERVER_IP。长度限制为1~80个字符。需满足以下要求:

  • 可用字符为小写字母、数字、短划线(-)和半角句号(.)。
  • 至少包含一个半角句号(.),半角句号(.)不能出现在开头或结尾。
  • 最右侧的域标签只能包含字母,不能包含数字或短划线(-)。
  • 对于其它域标签,短划线(-)不能出现在开头或结尾。

只有HealthCheckProtocolHTTP时才有该参数。

HealthCheckCodes Array of String http_2xx,http_3xx

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

默认值为http_2xx。健康检查正常的HTTP状态码,多个状态码用半角逗号(,)分隔。

取值:http_2xxhttp_3xxhttp_4xxhttp_5xx

说明 只有HealthCheckProtocol为HTTP时才有该参数。
HealthCheckInterval Integer 2

健康检查的时间间隔。

取值:1~50秒。

默认值:2秒。

HealthCheckTimeout Integer 5

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

取值:1~300秒。

默认值:5秒。

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

用于健康检查的URL。

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

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

健康检查方法。

取值:GETHEAD

默认值:HEAD

说明 只有HealthCheckProtocolHTTP时才有该参数。
HealthCheckProtocol String HTTP

健康检查采用的协议。

取值:HTTPTCP

默认值:HTTP

HealthCheckHttpVersion String HTTP 1.0

健康检查HTTP协议版本。

取值:HTTP 1.0HTTP 1.1

默认值:HTTP 1.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-1224334

健康检查模板ID。

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

示例

请求示例

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

正常返回示例

XML格式

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

<CreateHealthCheckTemplateResponse>
    <HealthCheckTemplateId>hct-1224334</HealthCheckTemplateId>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
</CreateHealthCheckTemplateResponse>

JSON格式

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

{
  "HealthCheckTemplateId" : "hct-1224334",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

错误码

HttpCode 错误码 错误信息 描述
400 QuotaExceeded.HealthCheckTemplatesNum The quota of %s is exceeded, usage %s/%s. 配额%s已超额度限制,目前已使用%s,配额为%s。

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