更新时间:2022-03-31 GMT+08:00
分享

查询健康检查列表

功能介绍

健康检查列表。

接口约束

  • 分页查询使用的参数为marker、limit、page_reverse。

  • marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/elb/healthmonitors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

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

使用说明:

  • 必须与limit一起使用。

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

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

limit

Integer

每页返回的个数。

最小值:0

最大值:2000

缺省值:2000

page_reverse

Boolean

分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。 使用说明:必须与limit一起使用。

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。 仅支持HTTP/HTTPS设置该字段,其他协议设置不会生效。 支持多值查询,查询条件格式:expected_codes=xxx&expected_codes=xxx

url_path

Array

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

使用说明:

  • 以"/"开头。仅当type为HTTP时生效。

支持多值查询,查询条件格式: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。

支持多值查询,查询条件格式:enterprise_project_id=xxx&enterprise_project_id=xxx

请求参数

表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

next_marker

String

分页查询结果中最后一条记录的ID。

current_count

Integer

当前的记录数。

表6 HealthMonitor

参数

参数类型

描述

admin_state_up

Boolean

健康检查的管理状态。取值:

  • true:表示开启健康检查,默认为true。

  • false表示关闭健康检查。

delay

Integer

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

最小值:1

最大值:50

domain_name

String

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

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

默认为空,表示使用负载均衡器的vip作为http请求的目的地址。

使用说明:

  • 仅当type为HTTP时生效。

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时生效。 不支持该字段,请勿使用。

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

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

使用说明:

  • 仅当type为HTTP时生效。

表7 PoolRef

参数

参数类型

描述

id

String

后端服务器组ID。

请求示例

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

响应示例

状态码: 200

操作正常返回。

{
  "healthmonitors" : [ {
    "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"
  }, {
    "monitor_port" : null,
    "id" : "cda1af03-0660-4fd2-8edf-e38c79846e08",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "domain_name" : "akik..un.com",
    "name" : "Healthmonitor-udp-test",
    "delay" : 50,
    "max_retries" : 1,
    "pools" : [ {
      "id" : "ae6e45ba-be84-4074-8ac6-bc4a56484809"
    } ],
    "admin_state_up" : false,
    "timeout" : 3,
    "type" : "UDP_CONNECT",
    "expected_codes" : null,
    "url_path" : "/world",
    "http_method" : null
  } ],
  "page_info" : {
    "next_marker" : "cda1af03-0660-4fd2-8edf-e38c79846e08",
    "previous_marker" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
    "current_count" : 2
  },
  "request_id" : "814bc40e-8b0a-4ced-b8e5-f136c3e1df6a"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close