更新时间:2026-01-16 GMT+08:00

查询健康检查详情

功能介绍

查询健康检查详情。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:项目ID。获取方式请参见获取项目ID

约束限制:不涉及

取值范围:长度为32个字符,由小写字母和数字组成。

默认取值:不涉及

healthmonitor_id

String

参数解释:健康检查ID。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:IAM鉴权Token。

约束限制:不涉及

取值范围:不涉及

默认取值:不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

request_id

String

参数解释:请求ID。

取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。

healthmonitor

HealthMonitor object

参数解释:监看检查对象。

表4 HealthMonitor

参数

参数类型

描述

admin_state_up

Boolean

健康检查的管理状态。

取值范围

  • true:表示开启健康检查。

  • false表示关闭健康检查。

delay

Integer

参数解释:健康检查间隔。

取值范围:1-50,单位:秒。

domain_name

String

参数解释:发送健康检查请求的域名。

取值范围:以数字或字母开头,只能包含数字、字母、’-’、’.’。

expected_codes

String

参数解释:期望响应状态码。

取值范围

  • 单值:单个返回码,例如200。

  • 列表:多个特定返回码,例如200,202。

  • 区间:一个返回码区间,例如200-204。

http_method

String

参数解释:HTTP请求方法。

取值范围:GET、HEAD、POST

id

String

参数解释:健康检查ID。

取值范围:不涉及

max_retries

Integer

参数解释:健康检查连续成功多少次后,将后端服务器的健康检查状态由OFFLINE判定为ONLINE。

取值范围:1-10

max_retries_down

Integer

参数解释:健康检查连续失败多少次后,将后端服务器的健康检查状态由ONLINE判定为OFFLINE。

取值范围:1-10

monitor_port

Integer

参数解释:健康检查端口号。

取值范围:1-65535和null,传null表示使用后端服务器端口号。

name

String

参数解释:健康检查名称。

取值范围:不涉及

pools

Array of PoolRef objects

参数解释:健康检查所在的后端服务器组ID列表。实际只会有一个后端服务器组ID。

取值范围:不涉及

project_id

String

参数解释:健康检查所在的项目ID。

取值范围:不涉及

timeout

Integer

参数解释:一次健康检查请求的超时时间。

取值范围:不涉及

type

String

参数解释: 健康检查请求协议。

取值范围:TCP、UDP_CONNECT、HTTP、HTTPS、TLS、GRPC。

url_path

String

参数解释:健康检查请求的请求路径。以"/"开头,默认为"/"。

取值范围:支持使用字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、半角问号(?)、井号(#)和and(&)以及扩展字符集_;~!()*[]@$^:',+

created_at

String

参数解释:创建时间。

取值范围:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。

updated_at

String

参数解释: 更新时间。

取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。

表5 PoolRef

参数

参数类型

描述

id

String

参数解释:后端服务器组ID。

取值范围:不涉及

请求示例

查询健康检查详情

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors/c2b210b2-60c4-449d-91e2-9e9ea1dd7441

响应示例

状态码:200

操作正常返回。

{
  "healthmonitor" : {
    "name" : "my-healthmonitor",
    "monitor_port" : null,
    "id" : "00b42a6a-0a16-47af-be4e-dc821fc316a3",
    "project_id" : "0c1503d710984bad92306faea3654dfd",
    "domain_name" : null,
    "delay" : 1,
    "max_retries" : 1,
    "max_retries_down" : 1,
    "pools" : [ {
      "id" : "c73600be-e3af-4d9f-bec2-f7c4ccf84b33"
    } ],
    "admin_state_up" : true,
    "timeout" : 1,
    "type" : "HTTP",
    "expected_codes" : "200",
    "url_path" : "/",
    "http_method" : "HEAD",
    "created_at" : "2024-08-08T09:00:34Z",
    "updated_at" : "2024-08-08T09:00:34Z"
  },
  "request_id" : "08660101bcaff627f2f48730cf837e5f"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码