查询健康检查列表

project_id

是

String

项目ID。

marker

否

String

上一页最后一条记录的ID。

使用说明：

• 必须与limit一起使用。

• 不指定时表示查询第一页。

• 该字段不允许为空或无效的ID。

limit

否

Integer

每页返回的个数。

最小值：0

最大值：2000

缺省值：2000

page_reverse

否

Boolean

是否反向查询。

取值：

• true：查询上一页。

• false：查询下一页，默认。

使用说明：

• 必须与limit一起使用。

• 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。

id

否

Array

健康检查ID。

支持多值查询，查询条件格式：id=xxx&id=xxx***。

monitor_port

否

Array

健康检查端口号。

支持多值查询，查询条件格式：monitor_port=xxx&monitor_port=xxx。

domain_name

否

Array

发送健康检查请求的域名。

取值：以数字或字母开头，只能包含数字、字母、’-’、’.’。

支持多值查询，查询条件格式：domain_name=xxx&domain_name=xxx。

name

否

Array

健康检查名称。

支持多值查询，查询条件格式：name=xxx&name=xxx。

delay

否

Array

健康检查间隔。

取值：1-50s。

支持多值查询，查询条件格式：delay=xxx&delay=xxx。

max_retries

否

Array

健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。取值范围：1-10。

支持多值查询，查询条件格式：max_retries=xxx&max_retries=xxx。

admin_state_up

否

Boolean

健康检查的管理状态。

取值：

• true：表示开启健康检查，默认为true。

• false表示关闭健康检查。

max_retries_down

否

Array

健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。取值范围：1-10。

支持多值查询，查询条件格式：max_retries_down=xxx&max_retries_down=xxx。

timeout

否

Integer

一次健康检查请求的超时时间。

type

否

Array

健康检查请求协议。

取值：TCP、UDP_CONNECT、HTTP、HTTPS。

支持多值查询，查询条件格式：type=xxx&type=xxx。

expected_codes

否

Array

期望响应状态码。

取值：

• 单值：单个返回码，例如200。

• 列表：多个特定返回码，例如200，202。

• 区间：一个返回码区间，例如200-204。

默认值：200。

仅支持HTTP/HTTPS设置该字段，其他协议设置不会生效。

支持多值查询，查询条件格式：expected_codes=xxx&expected_codes=xxx。

url_path

否

Array

健康检查测试member健康时发送的http请求路径。默认为“/”。

使用说明：以“/”开头。当type为HTTP/HTTPS时生效。

支持多值查询，查询条件格式：url_path=xxx&url_path=xxx。

http_method

否

Array

HTTP请求方法。

取值：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。

支持多值查询，查询条件格式：http_method=xxx&http_method=xxx。

不支持该字段，请勿使用。

enterprise_project_id

否

Array

企业项目ID。不传时查询default企业项目"0"下的资源，鉴权按照default企业项目鉴权； 如果传值，则传已存在的企业项目ID或all_granted_eps（表示查询所有企业项目）进行查询。

支持多值查询，查询条件格式： enterprise_project_id=xxx&enterprise_project_id=xxx。

X-Auth-Token

是

String

IAM鉴权Token

request_id

String

请求ID。

注：自动生成 。

page_info

PageInfo object

分页信息。

healthmonitors

Array of HealthMonitor objects

健康检查对象。

previous_marker

String

分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

next_marker

String

分页查询结果中最后一条记录的ID。通常用于查询下一页。

current_count

Integer

当前的记录数。

admin_state_up

Boolean

健康检查的管理状态。

取值：

• true：表示开启健康检查，默认为true。

• false表示关闭健康检查。

delay

Integer

健康检查间隔。取值：1-50s。

最小值：1

最大值：50

domain_name

String

发送健康检查请求的域名。

取值：以数字或字母开头，只能包含数字、字母、’-’、’.’。 默认为空，表示使用负载均衡器的vip作为http请求的目的地址。

使用说明：当type为HTTP/HTTPS时生效。

expected_codes

String

期望响应状态码。

取值：

• 单值：单个返回码，例如200。

• 列表：多个特定返回码，例如200，202。

• 区间：一个返回码区间，例如200-204。

默认值：200。

仅支持HTTP/HTTPS设置该字段，其他协议设置不会生效。

http_method

String

HTTP请求方法。

取值：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH，默认GET。

使用说明：当type为HTTP/HTTPS时生效。

不支持该字段，请勿使用。

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。

使用说明：

• 若pool的protocol为QUIC，则type只能是UDP_CONNECT。

• 若pool的protocol为UDP，则type只能UDP_CONNECT。

• 若pool的protocol为TCP，则type可以是TCP、HTTP、HTTPS。

• 若pool的protocol为HTTP，则type可以是TCP、HTTP、HTTPS。

• 若pool的protocol为HTTPS，则type可以是TCP、HTTP、HTTPS。

url_path

String

健康检查请求的请求路径。以"/"开头，默认为"/"。

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

使用说明：当type为HTTP/HTTPS时生效。

created_at

String

创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。

updated_at

String

更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。

id

String

后端服务器组ID。

200

操作正常返回。