更新健康检查
功能介绍
更新健康检查。
接口约束
如果该健康检查绑定的负载均衡器的provisioning状态不是ACTIVE，不能更新该健康检查。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
healthmonitor_id |
是 |
String |
健康检查ID |
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
IAM鉴权Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
healthmonitor |
是 |
UpdateHealthMonitorOption object |
健康检查对象。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
admin_state_up |
否 |
Boolean |
健康检查的管理状态。取值：
|
delay |
否 |
Integer |
健康检查间隔。取值：1-50s。 最小值：1 最大值：50 |
domain_name |
否 |
String |
发送健康检查请求的域名。 取值：以数字或字母开头，只能包含数字、字母、'-'、'.'。不能传空，但可传null或不传，表示使用负载均衡器的vip作为http请求的目的地址。 使用说明：
最小长度：1 最大长度：100 正则匹配：^[a-zA-Z0-9][a-zA-Z0-9-.]*$ |
expected_codes |
否 |
String |
期望响应状态码。支持多种取值格式：
仅支持HTTP/HTTPS设置该字段，其他协议设置不会生效。 最小长度：1 最大长度：64 正则匹配：^(([2-5]\d{2})|(([2-5]\d{2})-([2-5]\d{2})))(,(([2-5]\d{2})|(([2-5]\d{2})-([2-5]\d{2})))){0,4}$ |
http_method |
否 |
String |
HTTP请求方法，取值：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH，默认GET。 使用说明：
最小长度：1 最大长度：16 |
max_retries |
否 |
Integer |
健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。取值范围：1-10。 最小值：1 最大值：10 |
max_retries_down |
否 |
Integer |
健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。取值范围：1-10。 最小值：1 最大值：10 |
monitor_port |
否 |
Integer |
健康检查端口号。取值：1-65535，不可传入空，但可传入null，表示使用后端云服务器端口号。 最小值：1 最大值：65535 |
name |
否 |
String |
健康检查名称。 最小长度：0 最大长度：255 |
timeout |
否 |
Integer |
一次健康检查请求的超时时间。 建议该值小于delay的值。 最小值：1 最大值：50 |
url_path |
否 |
String |
健康检查请求的请求路径。以"/"开头，默认为"/"。 使用说明：
最小长度：1 最大长度：255 正则匹配：^(/([a-zA-Z0-9-._~!$&\'()*+,;=:@]|(%[a-fA-F0-9]{2}))*)+$ |
type |
否 |
String |
健康检查请求协议。 取值：TCP、UDP_CONNECT、HTTP、HTTPS。 使用说明：
|
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
request_id |
String |
请求ID。 注：自动生成 。 |
healthmonitor |
HealthMonitor object |
健康检查对象。 |
参数 |
参数类型 |
描述 |
|---|---|---|
admin_state_up |
Boolean |
健康检查的管理状态。取值：
|
delay |
Integer |
健康检查间隔。取值：1-50s。 最小值：1 最大值：50 |
domain_name |
String |
发送健康检查请求的域名。 取值：以数字或字母开头，只能包含数字、字母、'-'、'.'。 默认为空，表示使用负载均衡器的vip作为http请求的目的地址。 使用说明：
|
expected_codes |
String |
期望响应状态码。支持多种取值格式：
默认值：200。 仅支持HTTP/HTTPS设置该字段，其他协议设置不会生效。 |
http_method |
String |
HTTP请求方法，取值：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH，默认GET。 使用说明：
|
id |
String |
健康检查ID |
max_retries |
Integer |
健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。取值范围：1-10。 最小值：1 最大值：10 |
max_retries_down |
Integer |
健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。取值范围：1-10，默认3。 最小值：1 最大值：10 |
monitor_port |
Integer |
健康检查端口号。取值：1-65535，默认为空，表示使用后端云服务器端口号。 最小值：1 最大值：65535 |
name |
String |
健康检查名称。 |
pools |
Array of PoolRef objects |
健康检查所在的后端云服务器组ID列表。实际只会有一个后端云服务器组ID。 |
project_id |
String |
健康检查所在的项目ID。 |
timeout |
Integer |
一次健康检查请求的超时时间。 建议该值小于delay的值。 最小值：1 最大值：50 |
type |
String |
健康检查请求协议。取值：TCP、UDP_CONNECT、HTTP、HTTPS。 使用说明：
|
url_path |
String |
健康检查请求的请求路径。以"/"开头，默认为"/"。 使用说明：
|
请求示例
PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors/c2b210b2-60c4-449d-91e2-9e9ea1dd7441
{
"healthmonitor" : {
"name" : "My Healthmonitor update",
"max_retries" : 10,
"delay" : 10
}
}
响应示例
状态码： 200
操作正常返回。
{
"request_id" : "08d6ffea-d092-4cfa-860a-e364f3bef1be",
"healthmonitor" : {
"monitor_port" : null,
"id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
"project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
"domain_name" : null,
"name" : "My Healthmonitor update",
"delay" : 10,
"max_retries" : 10,
"pools" : [ {
"id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0"
} ],
"admin_state_up" : true,
"timeout" : 30,
"type" : "HTTP",
"expected_codes" : "200",
"url_path" : "/",
"http_method" : "GET"
}
}
状态码
状态码 |
描述 |
|---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。
