You need to enable JavaScript to run this app.
文档中心
负载均衡

负载均衡

复制全文
下载 pdf
健康检查模板
ModifyHealthCheckTemplatesAttributes - 修改健康检查模板属性
复制全文
下载 pdf
ModifyHealthCheckTemplatesAttributes - 修改健康检查模板属性
调用 ModifyHealthCheckTemplatesAttributes 接口,修改健康检查模板属性。​
使用说明​
  • 单次批量修改模板上限为 5 个。​
  • 每秒最多提交 10 个 API 请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
HealthCheckTemplates.N.HealthCheckTemplateId string[] 必选 示例值:HealthCheckTemplates.1.HealthCheckTemplateId=hctpl-123****765&HealthCheckTemplates.2.HealthCheckTemplateId=hctpl-iuytrfv​
健康检查模板ID。​
​
HealthCheckTemplates.N.HealthCheckPort integer[] 可选 示例值:HealthCheckTemplates.1.HealthCheckPort=80&HealthCheckTemplates.2.HealthCheckPort=81​
健康检查端口。取值如下:​
  • 0:使用后端服务器端口进行健康检查。​
  • 1-65535:使用您指定的端口进行健康检查。​
​
HealthCheckTemplates.N.Description string[] 可选 示例值:HealthCheckTemplates.1.Description=test1&HealthCheckTemplates.2.Description=test2​
健康检查描述。​
  • 不能以http://或https://开头。​
  • 必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。​
  • 长度限制为1 ~ 255个字符。​
  • 不填默认为空字符串。​
​
HealthCheckTemplates.N.HealthCheckDomain string[] 可选 示例值:HealthCheckTemplates.1.HealthCheckDomain=a.com&HealthCheckTemplates.2.HealthCheckDomain=b.com​
健康检查的域名。​
  • 只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。​
  • 要求如下:​
  • 需至少包含一个‘.’,且不允许以‘.’开头结尾。​
  • 单个字符串由字母、数字、‘-’、‘.’字符组成,‘-’不得出现在字符串的头部或尾部。​
  • 长度限制为1 ~ 128个字符。​
  • 不填则此参数为空,负载均衡默认使用各后端服务器的私网IP地址进行健康检查。​
​
HealthCheckTemplates.N.HealthCheckHttpCode string[] 可选 示例值:HealthCheckTemplates.1.HealthCheckHttpCode=http_2xx&HealthCheckTemplates.2.HealthCheckHttpCode=http_3xx,http_4xx​
健康检查正常的HTTP状态码。​
  • 多个状态码用以半角逗号分隔,只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。​
  • 取值如下:​
  • http_2xx​
  • http_3xx​
  • http_4xx​
  • http_5xx​
​
HealthCheckTemplates.N.HealthCheckHttpVersion string[] 可选 示例值:HealthCheckTemplates.1.HealthCheckHttpVersion=HTTP1.1&HealthCheckTemplates.N.HealthCheckHttpVersion=HTTP1.1​
健康检查HTTP协议版本。​
  • 只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。​
  • 取值如下:​
  • HTTP1.0​
  • HTTP1.1​
​
HealthCheckTemplates.N.HealthCheckInterval integer[] 可选 示例值:HealthCheckTemplates.1.HealthCheckInterval=2&HealthCheckTemplates.2.HealthCheckInterval=3​
执行健康检查的时间间隔。取值范围为1-300s。​
​
HealthCheckTemplates.N.HealthCheckMethod string[] 可选 示例值:HealthCheckTemplates.1.HealthCheckMethod=GET&HealthCheckTemplates.2.HealthCheckMethod=HEAD​
健康检查的方法。​
  • 只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。​
  • 取值如下:​
  • GET​
  • HEAD​
​
HealthCheckTemplates.N.HealthCheckProtocol string[] 可选 示例值:HealthCheckTemplates.1.HealthCheckProtocol=HTTP&HealthCheckTemplates.2.HealthCheckProtocol=HTTP​
健康检查的协议。取值如下:​
  • HTTP​
  • TCP​
​
HealthCheckTemplates.N.HealthCheckTemplateName string[] 可选 示例值:HealthCheckTemplates.1.HealthCheckTemplateName=test1&HealthCheckTemplates.2.HealthCheckTemplateName=test2​
健康检查模板的称。​
  • 不能以http://或https://开头。​
  • 必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。​
  • 长度限制在1-128字符之间。​
​
HealthCheckTemplates.N.HealthCheckTimeout integer[] 可选 示例值:HealthCheckTemplates.1.HealthCheckTimeout=2&HealthCheckTemplates.2.HealthCheckTimeout=3​
健康检查的响应超时时间,取值范围为1-60s。​
​
HealthCheckTemplates.N.HealthCheckURI string[] 可选 示例值:HealthCheckTemplates.1.HealthCheckURI=&HealthCheckTemplates.2.HealthCheckURI=abc​
健康检查的路径。​
  • 只有 HealthCheckProtocol 设置为 HTTP 时,该参数才生效。​
  • 要求如下:​
  • 必须以字符‘/’开头。​
  • 仅包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘=’字符。​
  • 长度限制为1 ~ 128个字符。​
  • 不填默认为“/”。​
​
HealthCheckTemplates.N.HealthyThreshold integer[] 可选 示例值:HealthCheckTemplates.1.HealthyThreshold=2&HealthCheckTemplates.2.HealthyThreshold=3​
健康检查的健康阈值,取值范围为2-10次。​
​
HealthCheckTemplates.N.UnhealthyThreshold integer[] 可选 示例值:HealthCheckTemplates.1.UnhealthyThreshold=2&HealthCheckTemplates.2.UnhealthyThreshold=3​
健康检查的不健康阈值,取值范围2-10次。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
​
​
请求示例​
​
GET /?Action=ModifyHealthCheckTemplatesAttributes&HealthCheckTemplates.1.Description=test&Version=2020-04-01&HealthCheckTemplates.1.HealthCheckTemplateId=hctpl-123*****876&HealthCheckTemplates.1.HealthCheckTemplateName=test&HealthCheckTemplates.1.HealthCheckHttpCode="http_2xx,http_3xx" HTTP/1.1​
Host: alb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20210816110638****2514606306AF947C",​
"Action": "ModifyHealthCheckTemplatesAttributes",​
"Version": "2020-04-01",​
"Service": "alb",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "202108161106****22514606306AF947C"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
Invalid%s.Malformed​
MismatchThe specified %s is malformed.​
指定的 %s 参数格式不合法。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, '%s'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: %s。​
400​
InvalidParameter​
Data unmarshal failed.​
请求解析失败。​
400​
InvalidIndexOrder.Malformed​
The specified index order is malformed.​
指定的索引顺序参数格式不合法。​
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。​
400​
InvalidHealthCheckTemplates.HealthCheckHttpVersion.Malformed​
The specified HealthCheckTemplates.HealthCheckHttpVersion is malformed.​
指定的 HealthCheckTemplates.HealthCheckHttpVersion 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckHttpCode.Malformed​
The specified HealthCheckTemplates.HealthCheckHttpCode is malformed.​
指定的 HealthCheckTemplates.HealthCheckHttpCode 参数格式不合法。​
400​
InvalidHealthCheckTemplates.UnhealthyThreshold.Malformed​
The specified HealthCheckTemplates.UnhealthyThreshold is malformed.​
指定的 HealthCheckTemplates.UnhealthyThreshold 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthyThreshold.Malformed​
The specified HealthCheckTemplates.HealthyThreshold is malformed.​
指定的 HealthCheckTemplates.HealthyThreshold 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckTimeout.Malformed​
The specified HealthCheckTemplates.HealthCheckTimeout is malformed.​
指定的 HealthCheckTemplates.HealthCheckTimeout 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckInterval.Malformed​
The specified HealthCheckTemplates.HealthCheckInterval is malformed.​
指定的 HealthCheckTemplates.HealthCheckInterval 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckURI.Malformed​
The specified HealthCheckTemplates.HealthCheckURI is malformed.​
指定的 HealthCheckTemplates.HealthCheckURI 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckDomain.Malformed​
The specified HealthCheckTemplates.HealthCheckDomain is malformed.​
指定的 HealthCheckTemplates.HealthCheckDomain 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckMethod.Malformed​
The specified HealthCheckTemplates.HealthCheckMethod is malformed.​
指定的 HealthCheckTemplates.HealthCheckMethod 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckProtocol.Malformed​
The specified HealthCheckTemplates.HealthCheckProtocol is malformed.​
指定的 HealthCheckTemplates.HealthCheckProtocol 参数格式不合法。​
400​
InvalidHealthCheckTemplates.Description.Malformed​
The specified HealthCheckTemplates.Description is malformed.​
指定的 HealthCheckTemplates.Description 参数格式不合法。​
400​
InvalidHealthCheckTemplates.HealthCheckTemplateName.Malformed​
The specified HealthCheckTemplates.HealthCheckTemplateName is malformed.​
指定的 HealthCheckTemplates.HealthCheckTemplateName 参数格式不合法。​
400​
LimitExceed.HealthCheckTemplate​
You've reached the limit on the number of health check templates that you can operate at a time.​
已达到单次可操作的健康检查模板的数量上限。​
400​
InvalidHealthCheckTemplates.HealthCheckPort.Malformed​
The specified HealthCheckTemplates.HealthCheckPort is malformed.​
指定的HealthCheckTemplates.HealthCheckPort参数格式不合法。​
404​
InvalidHealthCheckTemplate.NotFound​
The specified HealthCheckTemplate does not exist.​
指定的健康检查模板不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。请稍后重试或联系工程师进一步咨询。​
​
​
最近更新时间:2026.02.27 11:57:37
这个页面对您有帮助吗?
有用
有用
无用
无用