You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /应用型负载均衡/开发指南/API 参考/健康检查接口/CreateHealthCheckTemplates
CreateHealthCheckTemplates
最近更新时间：2024.06.28 16:26:02首次发布时间：2022.05.20 22:34:12
我的收藏

请求说明

API 名称：CreateHealthCheckTemplates。
API 域名：open.volcengineapi.com 。
API 描述：创建健康检查模板。单次批量创建模板上限为5个，单个账号在每个地域创建健康检查模板上限为50个。

使用限制

节流限制：每秒最多提交 10 个 API 请求。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称，如 CreateHealthCheckTemplates。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint否900表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数类型是否必选参数说明示例值
HealthCheckTemplates
Array
是
健康检查模板的相关信息，具体请参见下表 HealthCheckTemplates 。
-

HealthCheckTemplates

参数类型是否必选参数说明示例值
HealthCheckTemplates.N.HealthCheckTemplateName
List of Struct
是

健康检查模板的名字，具体要求如下：

  • 不能以http://或https://开头。
  • 必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。
  • 长度限制在1-128字符之间。
  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckTemplateName=test1&HealthCheckTemplates.2.HealthCheckTemplateName=test2
HealthCheckTemplates.N.Description
List of Struct
否

健康检查描述，要求如下：

  • 不能以http://或https://开头。
  • 必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。） 。
  • 长度限制为1 ～ 255个字符。
  • 不填默认为空字符串。
  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.Description=test1&HealthCheckTemplates.2.Description=test2
HealthCheckTemplates.N.HealthCheckInterval
List of Struct
否

执行健康检查的时间间隔，默认为2，取值1-300s 。

  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckInterval=2&HealthCheckTemplates.2.HealthCheckInterval=3
HealthCheckTemplates.N.HealthCheckTimeout
List of Struct
否

健康检查的响应超时时间，默认为2，取值1-60s 。

  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckTimeout=2&HealthCheckTemplates.2.HealthCheckTimeout=3
HealthCheckTemplates.N.HealthyThreshold
List of Struct
否

健康检查的健康阈值，默认为3，取值2-10次。

  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthyThreshold=2&HealthCheckTemplates.2.HealthyThreshold=3
HealthCheckTemplates.N.UnhealthyThreshold
List of Struct
否

健康检查的不健康阈值，默认为3，取值2-10次。

  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.UnhealthyThreshold=2&HealthCheckTemplates.2.UnhealthyThreshold=3
HealthCheckTemplates.N.HealthCheckMethod
List of Struct
否

健康检查的方法，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。支持GET和HEAD（默认方法）。

  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckMethod=GET&HealthCheckTemplates.2.HealthCheckMethod=HEAD
HealthCheckTemplates.N.HealthCheckDomain
List of Struct
否

健康检查的域名，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：

  • 需至少包含一个‘.’，且不允许以‘.’开头结尾。
  • 单个字符串由字母、数字、‘-’、‘.’字符组成，‘-’不得出现在字符串的头部或尾部。
  • 长度限制为1 ～ 128个字符。
  • 不填则此参数为空，负载均衡默认使用各后端服务器的私网IP地址进行健康检查。
  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckDomain=a.com&HealthCheckTemplates.2.HealthCheckDomain=b.com
HealthCheckTemplates.N.HealthCheckURI
List of Struct
否

健康检查的路径，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。要求如下：

  • 必须以字符‘/’开头。
  • 仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’字符。
  • 长度限制为1 ～ 128个字符。
  • 不填默认为“/”。
  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckURI=&HealthCheckTemplates.2.HealthCheckURI=abc
HealthCheckTemplates.N.HealthCheckHttpCode
List of Struct
否
  • 健康检查正常的HTTP状态码，多个状态码用以半角逗号分隔，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。支持：
    • http_2xx（默认）。
    • http_3xx（默认） 。
    • http_4xx 。
    • http_5xx 。
  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckHttpCode=http_2xx&HealthCheckTemplates.2.HealthCheckHttpCode=http_3xx,http_4xx
HealthCheckTemplates.N.HealthCheckProtocol
List of Struct
否

健康检查的协议，当前支持 HTTP、TCP 。

  • - N：表示健康检查模板的序号，取值范围为1 ～ 5。
  • 多个健康检查模板间使用“&”分隔。
HealthCheckTemplates.1.HealthCheckProtocol=HTTP&HealthCheckTemplates.2.HealthCheckProtocol=HTTP

HealthCheckTemplates.N.HealthCheckHttpVersion

List of Struct

否

健康检查HTTP协议版本，只有 HealthCheckProtocol 设置为 HTTP 时，该参数才生效。取值：

  • HTTP1.0（默认值）。

  • HTTP1.1。

HTTP1.0

返回参数

参数类型参数说明示例值
RequestId
String
请求ID 。
20210816110638****2514606306AF947C
HealthCheckTemplateIDsList of String健康检查模板IDs 。["hctpl-123*****432","hctpl-123***765"]

示例

请求示例

GET /?Action=CreateHealthCheckTemplates&HealthCheckTemplates.1.Description=test&Version=2020-04-01&HealthCheckTemplates.1.HealthCheckTemplateName=test&HealthCheckTemplates.1.HealthCheckHttpCode="http_2xx,http_3xx" HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "CreateHealthCheckTemplates",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202108161106****22514606306AF947C",
        "HealthCheckTemplateIDs": ["hctpl-123*****432"]
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code

错误码

错误信息

错误描述

400

LimitExceed.HealthCheckTemplate

You've reached the limit on the number of health check templates that you can operate at a time.

已达到单次可操作的健康检查模板的数量上限。

400

InvalidIndexOrder.Malformed

The specified index order is malformed.

指定的索引顺序参数格式不合法。

400InvalidHealthCheckTemplates.HealthCheckTemplateName.MalformedThe specified HealthCheckTemplates.HealthCheckTemplateName is malformed.指定的 HealthCheckTemplates.HealthCheckTemplateName 参数格式不合法。
400InvalidHealthCheckTemplates.Description.MalformedThe specified HealthCheckTemplates.Description is malformed.指定的 HealthCheckTemplates.Description 参数格式不合法。
400InvalidHealthCheckTemplates.HealthCheckProtocol.MalformedThe specified HealthCheckTemplates.HealthCheckProtocol is malformed.指定的 HealthCheckTemplates.HealthCheckProtocol 参数格式不合法。
400InvalidHealthCheckTemplates.HealthCheckMethod.MalformedThe specified HealthCheckTemplates.HealthCheckMethod is malformed.指定的 HealthCheckTemplates.HealthCheckMethod 参数格式不合法。
400InvalidHealthCheckTemplates.HealthCheckDomain.MalformedThe specified HealthCheckTemplates.HealthCheckDomain is malformed.指定的 HealthCheckTemplates.HealthCheckDomain 参数格式不合法。
400InvalidHealthCheckTemplates.HealthCheckURI.MalformedThe specified HealthCheckTemplates.HealthCheckURI is malformed.指定的 HealthCheckTemplates.HealthCheckURI 参数格式不合法。
400InvalidHealthCheckTemplates.HealthCheckInterval.MalformedThe specified HealthCheckTemplates.HealthCheckInterval is malformed.指定的 HealthCheckTemplates.HealthCheckInterval 参数格式不合法。
400InvalidHealthCheckTemplates.HealthCheckTimeout.MalformedThe specified HealthCheckTemplates.HealthCheckTimeout is malformed.指定的 HealthCheckTemplates.HealthCheckTimeout 参数格式不合法。
400InvalidHealthCheckTemplates.HealthyThreshold.MalformedThe specified HealthCheckTemplates.HealthyThreshold is malformed.指定的 HealthCheckTemplates.HealthyThreshold 参数格式不合法。
400InvalidHealthCheckTemplates.UnhealthyThreshold.MalformedThe specified HealthCheckTemplates.UnhealthyThreshold is malformed.指定的 HealthCheckTemplates.UnhealthyThreshold 参数格式不合法。
400InvalidHealthCheckTemplates.HealthCheckHttpCode.MalformedThe specified HealthCheckTemplates.HealthCheckHttpCode is malformed.指定的 HealthCheckTemplates.HealthCheckHttpCode 参数格式不合法。
400QuotaExceed.HealthCheckTempPerRegionYou've reached the limit on the number of health check templates the current region you can create in, usage xx/xx.已达到当前地域可创建的健康检查模板的数量上限。目前已使用xxx，配额为xxx。

400

InvalidHealthCheckTemplates.HealthCheckHttpVersion.Malformed

The specified HealthCheckTemplates.HealthCheckHttpVersion is malformed.

指定的 HealthCheckTemplates.HealthCheckHttpVersion 参数格式不合法。

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'HealthCheckTemplates.HealthCheckDomain'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: HealthCheckTemplates.HealthCheckDomain。