调用ListHealthCheckTemplates查询指定健康检查模板的属性值。

调试

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

请求参数

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

要执行的操作。

取值:ListHealthCheckTemplates

NextToken String t-2343r

用来标记当前开始读取的位置,置空表示从头开始。

MaxResults Integer 50

本次读取的最大数据记录。

取值:1~100

默认值:20,表示用户传入的数据为空。

HealthCheckTemplateIds Array of String hct-bp1qjwo61pqz3ahltv****

健康检查模版ID。最多支持20个健康检查模板ID。如果传入则根据模板ID过滤。

HealthCheckTemplateNames Array of String test

健康检查模版名称。最多支持10个健康检查模板名称。如果传入则根据模板名称过滤。

返回数据

名称 类型 示例值 描述
HealthCheckTemplates Array of HealthCheckTemplate

健康检查模板列表。

HealthCheckConnectPort Integer 80

健康检查使用的端口。

取值: 0~65535

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

HealthCheckHost String $_ip

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

$SERVER_IP(默认值): 后端服务器的私网IP。当指定了IP或该参数未指定时,负载均衡会使用各后端服务器的私网IP当做健康检查使用的域名。

domain:域名长度为1~80字符,只能包含字母、数字、半角句号(.)和短划线(-)。

说明 只有HealthCheckProtocolHTTP时才有效。
HealthCheckCodes Array of String http_2xx,http_3xx

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

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

取值:http_2xxhttp_3xxhttp_4xxhttp_5xx

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

健康检查HTTP协议版本。

取值:HTTP 1.0HTTP 1.1

默认值:HTTP 1.1

说明 只有HealthCheckProtocolHTTP时才有效。
HealthCheckInterval Integer 5

健康检查的时间间隔。

取值:1~50秒。

默认值:2秒。

HealthCheckMethod String HEAD

健康检查方法。

取值:GETHEAD

默认值:HEAD

说明 只有HealthCheckProtocolHTTP时才有效。
HealthCheckPath String /test/index.html

用于健康检查的URL。

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

HealthCheckProtocol String HTTP

健康检查采用的协议。

取值:HTTPTCP

默认值:HTTP

HealthCheckTemplateId String hct-bp1qjwo61pqz3ahltv****

健康检查模板ID。

HealthCheckTemplateName String HealthCheckTemplate1

健康检查模板名称。

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

HealthCheckTimeout Integer 3

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

取值:1~300秒。

默认值:5秒。

说明 如果HealthCHeckTimeout的值小于HealthCheckInterval的值,则HealthCHeckTimeout无效,超时时间为HealthCheckInterval的值。
HealthyThreshold Integer 4

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

取值:2~10

默认值:3

UnhealthyThreshold Integer 4

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

取值:2~10

默认值:3

MaxResults Integer 50

本次读取的最大数据记录。

取值:1~100

默认值:20,表示用户传入的数据为空。

NextToken String t-2343r

用来标记当前开始读取的位置,置空表示从头开始。

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

请求ID。

TotalCount Integer 1000

本次请求条件下的数据总量。

示例

请求示例

http(s)://[Endpoint]/?Action=ListHealthCheckTemplates
&NextToken=t-2343r
&MaxResults=50
&HealthCheckTemplateIds=["hct-bp1qjwo61pqz3ahltv****"]
&HealthCheckTemplateNames=["test"]
&公共请求参数

正常返回示例

XML格式

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

<ListHealthCheckTemplatesResponse>
    <HealthCheckTemplates>
        <HealthCheckConnectPort>80</HealthCheckConnectPort>
        <HealthCheckHost>$_ip</HealthCheckHost>
        <HealthCheckCodes>http_2xx,http_3xx</HealthCheckCodes>
        <HealthCheckHttpVersion>HTTP 1.0</HealthCheckHttpVersion>
        <HealthCheckInterval>5</HealthCheckInterval>
        <HealthCheckMethod>HEAD</HealthCheckMethod>
        <HealthCheckPath>/test/index.html</HealthCheckPath>
        <HealthCheckProtocol>HTTP</HealthCheckProtocol>
        <HealthCheckTemplateId>hct-bp1qjwo61pqz3ahltv****</HealthCheckTemplateId>
        <HealthCheckTemplateName>HealthCheckTemplate1</HealthCheckTemplateName>
        <HealthCheckTimeout>3</HealthCheckTimeout>
        <HealthyThreshold>4</HealthyThreshold>
        <UnhealthyThreshold>4</UnhealthyThreshold>
    </HealthCheckTemplates>
    <MaxResults>50</MaxResults>
    <NextToken>t-2343r</NextToken>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <TotalCount>1000</TotalCount>
</ListHealthCheckTemplatesResponse>

JSON格式

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

{
  "HealthCheckTemplates" : {
    "HealthCheckConnectPort" : 80,
    "HealthCheckHost" : "$_ip",
    "HealthCheckCodes" : "http_2xx,http_3xx",
    "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
  },
  "MaxResults" : 50,
  "NextToken" : "t-2343r",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount" : 1000
}

错误码

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