查询健康检查列表

功能介绍

健康检查列表。

接口约束

分页查询使用的参数为marker、limit、page_reverse。
marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/elb/healthmonitors

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方式请参见获取项目ID。约束限制：不涉及取值范围：长度为32个字符，由小写字母和数字组成。默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
marker	否	String	参数解释：上一页最后一条记录的ID。约束限制：必须与limit一起使用。不指定时表示查询第一页。该字段不允许为空或无效的ID。取值范围：不涉及默认取值：不涉及
limit	否	Integer	参数解释：每页返回的个数。约束限制：不涉及取值范围：0-2000 默认取值：2000
page_reverse	否	Boolean	参数解释：是否反向查询。约束限制：必须与limit一起使用。当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。取值范围： true：查询上一页。 false：查询下一页。默认取值：false
id	否	Array of strings	参数解释：健康检查ID。支持多值查询，查询条件格式：id=xxx&id=xxx*。约束限制：不涉及取值范围：不涉及默认取值**：不涉及
monitor_port	否	Array of integers	参数解释：健康检查端口号。支持多值查询，查询条件格式：monitor_port=xxx&monitor_port=xxx。约束限制：不涉及取值范围：不涉及默认取值：不涉及
domain_name	否	Array of strings	参数解释：发送健康检查请求的域名。支持多值查询，查询条件格式：domain_name=xxx&domain_name=xxx。约束限制：不涉及取值范围：以数字或字母开头，只能包含数字、字母、’-’、’.’。默认取值：不涉及
name	否	Array of strings	参数解释：健康检查名称。支持多值查询，查询条件格式：name=xxx&name=xxx。约束限制：不涉及取值范围：不涉及默认取值：不涉及
delay	否	Array of integers	参数解释：健康检查间隔。支持多值查询，查询条件格式：delay=xxx&delay=xxx。约束限制：不涉及取值范围：1-50，单位：秒。默认取值：不涉及
max_retries	否	Array of integers	参数解释：健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。支持多值查询，查询条件格式：max_retries=xxx&max_retries=xxx。约束限制：不涉及取值范围：1-10 默认取值：不涉及
admin_state_up	否	Boolean	参数解释：健康检查的管理状态。约束限制：不涉及取值范围： true：表示开启健康检查。 false表示关闭健康检查。默认取值：不涉及
max_retries_down	否	Array of integers	参数解释：健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。支持多值查询，查询条件格式：max_retries_down=xxx&max_retries_down=xxx。约束限制：不涉及取值范围：1-10 默认取值：不涉及
timeout	否	Integer	参数解释：一次健康检查请求的超时时间。约束限制：不涉及取值范围：不涉及默认取值：不涉及
type	否	Array of strings	参数解释：健康检查请求协议。支持多值查询，查询条件格式：type=xxx&type=xxx。约束限制：不涉及取值范围：TCP、UDP_CONNECT、HTTP、HTTPS、TLS、GRPC。默认取值：不涉及
expected_codes	否	Array of strings	参数解释：期望响应状态码。支持多值查询，查询条件格式：expected_codes=xxx&expected_codes=xxx。约束限制：不涉及取值范围：单值：单个返回码，例如200。列表：多个特定返回码，例如200，202。区间：一个返回码区间，例如200-204。默认取值：不涉及
url_path	否	Array of strings	参数解释：健康检查测试member健康时发送的http请求路径。支持多值查询，查询条件格式：url_path=xxx&url_path=xxx。约束限制：不涉及取值范围：不涉及默认取值：不涉及
http_method	否	Array of strings	参数解释：HTTP请求方法。支持多值查询，查询条件格式：http_method=xxx&http_method=xxx。约束限制：不涉及取值范围：GET、HEAD、POST 默认取值：不涉及
enterprise_project_id	否	Array of strings	参数解释：资源所属的企业项目ID。支持多值查询，查询条件格式：enterprise_project_id=xxx&enterprise_project_id=xxx。约束限制：如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:healthmonitors:list权限。如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。取值范围：不涉及默认取值：不涉及

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：IAM鉴权Token。约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
request_id	String	参数解释：请求ID。取值范围：由数字、小写字母和中划线（-）组成的字符串，自动生成。
page_info	PageInfo object	参数解释：分页信息。
healthmonitors	Array of HealthMonitor objects	参数解释：健康检查对象。

表5 PageInfo
参数	参数类型	描述
previous_marker	String	参数解释：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。取值范围：不涉及
next_marker	String	参数解释：分页查询结果中最后一条记录的ID。通常用于查询下一页。取值范围：不涉及
current_count	Integer	参数解释：当前页返回记录数。取值范围：不涉及

表6 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时区。

表7 PoolRef
参数	参数类型	描述
id	String	参数解释：后端服务器组ID。取值范围：不涉及

请求示例

查询健康检查列表

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors

响应示例

状态码：200

操作正常返回。

{
  "request_id" : "306b2ed05d05341a2157906d60c06718",
  "healthmonitors" : [ {
    "name" : "my-healthmonitor-1",
    "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"
  }, {
    "name" : "my-healthmonitor-2",
    "monitor_port" : null,
    "id" : "00d4e6b4-587a-479a-a8ab-662b51f70170",
    "project_id" : "0c1503d710984bad92306faea3654dfd",
    "domain_name" : null,
    "delay" : 5,
    "max_retries" : 3,
    "max_retries_down" : 3,
    "pools" : [ {
      "id" : "e74c1541-e1d5-497c-9af3-3166202ed3f1"
    } ],
    "admin_state_up" : true,
    "timeout" : 3,
    "type" : "TCP",
    "expected_codes" : "200",
    "url_path" : "/",
    "http_method" : "GET",
    "created_at" : "2024-11-07T13:35:18Z",
    "updated_at" : "2024-11-07T13:35:18Z"
  } ],
  "page_info" : {
    "next_marker" : "00d4e6b4-587a-479a-a8ab-662b51f70170",
    "previous_marker" : "00b42a6a-0a16-47af-be4e-dc821fc316a3",
    "current_count" : 2
  }
}

状态码

状态码	描述
200	操作正常返回。

错误码

请参见错误码。

父主题： 健康检查

上一篇：创建健康检查

下一篇：查询健康检查详情

查询健康检查列表

功能介绍

接口约束

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

您对此文档页面的整体评价？