文档

ListHealthCheckTemplates - 查询健康检查模板

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alb:ListHealthCheckTemplatesList
  • HealthCheckTemplate
    acs:alb:{#regionId}:{#accountId}:healthchecktemplate/*

请求参数

名称类型必填描述示例值
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

50
HealthCheckTemplateIdsarray

健康检查模版 ID 列表。

string

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

hct-bp1qjwo61pqz3ahltv****
HealthCheckTemplateNamesarray

健康检查模板名称列表。

string

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

test
Tagobject []

标签。

Keystring

标签键。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

env
Valuestring

标签值。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

product

返回参数

名称类型描述示例值
object

健康检查模板信息。

HealthCheckTemplatesobject []

健康检查模板列表。

HealthCheckConnectPortinteger

健康检查使用的端口。

取值:** 0~65535**。

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

80
HealthCheckHoststring

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

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

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

说明 只有HealthCheckProtocolHTTPHTTPS 时才有效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
$SERVER_IP
HealthCheckCodesarray

健康检查正常的状态码列表。

string

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

  • HealthCheckProtocol 取值为 HTTPHTTPS 时,HealthCheckCodes 可以选择http_2xx(默认值)、 http_3xxhttp_4xxhttp_5xx,多个状态码用半角逗号(,)分隔。

  • HealthCheckProtocol 取值为 gRPC 时,HealthCheckCodes 状态码范围:0~99,默认值:0。支持范围输入,最多支持 20 个范围值,多个范围值使用半角逗号(,)隔开。

说明 只有 HealthCheckProtocolHTTPHTTPSgRPC 时才有该参数。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
http_2xx
HealthCheckHttpVersionstring

健康检查 HTTP 协议版本。

取值:HTTP 1.0HTTP 1.1

默认值:HTTP 1.1

说明 只有HealthCheckProtocolHTTPHTTPS 时才有效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
HTTP 1.0
HealthCheckIntervalinteger

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

5
HealthCheckMethodstring

健康检查方法。取值:

  • HEAD(默认值):HTTP 和 HTTPS 监听健康检查默认采用 HEAD 方法。

  • GET:如果响应报文长度超过 8K,会被截断,但不会影响健康检查结果的判定。

  • POST:gRPC 监听健康检查默认采用 POST 方法。

说明 只有 HealthCheckProtocolHTTPHTTPSgRPC 时才有效。(HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。)
HEAD
HealthCheckPathstring

用于健康检查的 URL。

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

/test/index.html
HealthCheckProtocolstring

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

  • HTTP(默认值):通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。

  • HTTPS:通过发送 HEAD 或 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。(数据加密,相比 HTTP 更安全。)

  • TCP:通过发送 SYN 握手报文来检测服务器端口是否存活。

  • gRPC:通过发送 POST 或 GET 请求来检查服务器应用是否健康。

说明 HTTPS 协议默认不开放,如需使用,请登录负载均衡控制台的配额管理页面,在应用型负载均衡 ALB页签申请权益配额。
HTTP
HealthCheckTemplateIdstring

健康检查模板 ID。

hct-bp1qjwo61pqz3ahltv****
HealthCheckTemplateNamestring

健康检查模板名称。

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

HealthCheckTemplate1
HealthCheckTimeoutinteger

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

取值:1~300秒。

默认值:5 秒。

说明 如果 HealthCHeckTimeout 的值小于 HealthCheckInterval 的值,则 HealthCHeckTimeout 无效,超时时间为 HealthCheckInterval 的值。
3
HealthyThresholdinteger

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

取值:2~10

默认值:3

4
UnhealthyThresholdinteger

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

取值:2~10

默认值:3

4
Tagsobject []

标签。

Keystring

标签键。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

env
Valuestring

标签值。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

product
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

50
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF3******
TotalCountinteger

本次请求条件下返回的总数据记录数。

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错误码错误信息描述
403Forbidden.HealthCheckTemplateAuthentication has failed for HealthCheckTemplate.对HealthCheckTemplate鉴权失败

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

变更历史

变更时间变更内容概要操作
2024-01-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:403
  • 本页导读 (1)
文档反馈