健康检查器

列举查询健康检查器

功能介绍

查询健康检查器列表

URI

GET /v2.0/lbaas/healthmonitors

请求消息

参数	参数类型	是否必选	描述
fields	string	否	你想让服务器返回的字段。如果没有指定字段的查询参数，API会返回所有健康检查器的属性。通过使用fields参数，API只返回请求的属性集。可以指定多个字段的参数。例如，如果您指定fields=id&fields=name的请求URL，那么只有id和name属性将返回。
project_id	string	否	指定项目ID进行查询。

响应消息

参数	参数类型	描述
admin_state_up	boolean	健康检查器的管理状态。true表示启用，false表示停用
created_at	string	健康检查器创建的时间。
delay	integer	发送健康检查请求到成员的间隔时间，以秒为单位。
domain_name	string	发送健康检查请求的域名。 此字段暂不支持产品化配置，请勿使用。
expected_codes	string	HTTP状态代码列表，该列表期望从成员响应中声明它是健康的。
http_method	string	健康检查器的HTTP请求方法。 取值为：CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT或TRACE。默认为GET。 此字段暂不支持产品化配置，请勿使用。
http_version	float	健康检查请求的HTTP版本。 取值为：1.0或1.1，默认是1.0。 此字段暂不支持产品化配置，请勿使用。
id	uuid	健康检查器的ID。
max_retries	integer	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
max_retries_down	integer	将后端服务器member的健康检查状态置为OFFLINE的连续检查失败次数。有效值是从1到10。
name	string	健康检查器的名称。
operating_status	string	健康检查器的运行状态。
pool_id	uuid	健康检查器关联的资源池ID。
project_id	string	健康检查器所属的项目ID。
provisioning_status	string	健康检查器的配置状态。
tags	list	标签。
timeout	integer	健康检查请求的超时时间（以秒为单位）。该值必须小于延迟值。
type	string	健康检查请求的协议类型。取值为：TCP、HTTP、PING、UDP-CONNECT。
updated_at	string	健康检查器最后一次更新的时间。
url_path	string	健康检查测试后端member健康时发送的http请求路径。必须是以正斜杠(/)开头的字符串。 此字段暂不支持产品化配置，请勿使用。

请求示例

curl -X GET -H "X-Auth-Token: <token>" http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/healthmonitors

正常响应示例

{
  "healthmonitors": [
    {
      "id": "8551f03a-3777-4f64-932f-daaddc0147b5",
      "name": "",
      "type": "HTTP",
      "delay": 5,
      "timeout": 4,
      "max_retries": 3,
      "max_retries_down": 3,
      "http_method": "GET",
      "url_path": "/",
      "expected_codes": "200",
      "admin_state_up": true,
      "project_id": "250a86f0dcc9467285fa8af54457e885",
      "pools": [
        {
          "id": "fa549f85-fa3a-4280-bb2a-00b09285e6b3"
        }
      ],
      "provisioning_status": "ACTIVE",
      "operating_status": "ONLINE",
      "created_at": "2022-04-25T07:42:03",
      "updated_at": "2022-04-25T11:22:39",
      "tags": [],
      "http_version": null,
      "domain_name": null,
      "tenant_id": "250a86f0dcc9467285fa8af54457e885"
    }
  ],
  "healthmonitors_links": []
}

正常响应代码

200

错误码

400，401，500

创建健康检查器

功能介绍

创建健康检查器。

接口约束

1. UDP-CONNECT的检查健康器只能使用在UDP的pool资源池上。

URI

POST /v2.0/lbaas/healthmonitors

请求消息

参数	参数类型	是否必选	描述
admin_state_up	boolean	否	健康检查器的管理状态。true表示启用，false表示停用
delay	integer	是	发送健康检查请求到成员的间隔时间，以秒为单位。
domain_name	string	否	发送健康检查请求的域名。 此字段暂不支持产品化配置，请勿使用。
expected_codes	string	否	HTTP状态代码列表，该列表期望从成员响应中声明它是健康的。
http_method	string	否	健康检查器的HTTP请求方法。 取值为：CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT或TRACE。默认为GET。 此字段暂不支持产品化配置，请勿使用。
http_version	float	否	健康检查请求的HTTP版本。 取值为：1.0或1.1，默认是1.0。 此字段暂不支持产品化配置，请勿使用。
name	string	否	健康检查器的名称。
max_retries	integer	是	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
max_retries_down	integer	否	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
pool_id	uuid	是	健康检查器关联的资源池ID。
project_id	string	否	健康检查器所属的项目ID。
tags	list	否	标签。
timeout	integer	是	健康检查请求的超时时间（以秒为单位）。该值必须小于延迟值。
type	string	是	健康检查请求的协议类型。取值为：TCP、HTTP、PING。
url_path	string	否	健康检查测试后端member健康时发送的http请求路径。必须是以正斜杠(/)开头的字符串。 此字段暂不支持产品化配置，请勿使用。

响应消息

参数	参数类型	描述
admin_state_up	boolean	健康检查器的管理状态。true表示启用，false表示停用
created_at	string	健康检查器创建的时间。
delay	integer	发送健康检查请求到成员的间隔时间，以秒为单位。
domain_name	string	发送健康检查请求的域名。 此字段暂不支持产品化配置，请勿使用。
expected_codes	string	HTTP状态代码列表，该列表期望从成员响应中声明它是健康的。 此字段暂不支持产品化配置，请勿使用。
http_method	string	健康检查器的HTTP请求方法。 取值为：CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT或TRACE。默认为GET。 此字段暂不支持产品化配置，请勿使用。
http_version	float	健康检查请求的HTTP版本。 取值为：1.0或1.1，默认是1.0。 此字段暂不支持产品化配置，请勿使用。
id	uuid	健康检查器的ID。
max_retries	integer	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
max_retries_down	integer	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
name	string	健康检查器的名称。
operating_status	string	健康检查器的运行状态。
pool_id	uuid	健康检查器关联的资源池ID。
project_id	string	健康检查器所属的项目ID。
provisioning_status	string	健康检查器的配置状态。
tags	list	标签。
timeout	integer	健康检查请求的超时时间（以秒为单位）。该值必须小于延迟值。
type	string	健康检查请求的协议类型。取值为：TCP、HTTP、PING、UDP-CONNECT。
updated_at	string	健康检查器最后一次更新的时间。
url_path	string	健康检查测试后端member健康时发送的http请求路径。必须是以正斜杠(/)开头的字符串。 此字段暂不支持产品化配置，请勿使用。

请求示例

curl -X POST -H "X-Auth-Token: <token>" -d '{"healthmonitor": {"pool_id": "fa549f85-fa3a-4280-bb2a-00b09285e6b3", "name": "demo-hm", "delay": 3, "http_method": "GET", "timeout": 4, "max_retries": 3, "type": "HTTP", "admin_state_up": true}}' http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/healthmonitors

{
  "healthmonitor": {
    "pool_id": "fa549f85-fa3a-4280-bb2a-00b09285e6b3",
    "name": "demo-hm",
    "delay": 3,
    "http_method": "GET",
    "timeout": 4,
    "max_retries": 3,
    "type": "HTTP",
    "admin_state_up": true
  }
}

正常响应示例

{
  "healthmonitor": {
    "id": "a3490653-d64b-4ebb-9e64-3c3b7b899a61",
    "name": "demo-hm",
    "type": "HTTP",
    "delay": 3,
    "timeout": 4,
    "max_retries": 3,
    "max_retries_down": 3,
    "http_method": "GET",
    "url_path": "/",
    "expected_codes": "200",
    "admin_state_up": true,
    "project_id": "250a86f0dcc9467285fa8af54457e885",
    "pools": [
      {
        "id": "fa549f85-fa3a-4280-bb2a-00b09285e6b3"
      }
    ],
    "provisioning_status": "PENDING_CREATE",
    "operating_status": "OFFLINE",
    "created_at": "2022-04-26T02:21:49",
    "updated_at": null,
    "tags": [],
    "http_version": null,
    "domain_name": null,
    "tenant_id": "250a86f0dcc9467285fa8af54457e885"
  }
}

正常响应代码

201

错误码

400，401，403，404，409，500，503

查询健康检查器详情

功能介绍

查询健康检查器详情。

URI

GET /v2.0/lbaas/healthmonitors/{healthmonitor_id}

参数	是否必选	描述
healthmonitor_id	是	待查询的健康检查器的ID。

请求消息

参数	参数类型	是否必选	描述
fields	string	否	你想让服务器返回的字段。如果没有指定字段的查询参数，API会返回所有健康检查器的属性。通过使用fields参数，API只返回请求的属性集。可以指定多个字段的参数。例如，如果您指定fields=id&fields=name的请求URL，那么只有id和name属性将返回。

响应消息

参数	参数类型	描述
admin_state_up	boolean	健康检查器的管理状态。true表示启用，false表示停用
created_at	string	健康检查器创建的时间。
delay	integer	发送健康检查请求到成员的间隔时间，以秒为单位。
domain_name	string	发送健康检查请求的域名。 此字段暂不支持产品化配置，请勿使用。
expected_codes	string	HTTP状态代码列表，该列表期望从成员响应中声明它是健康的。 此字段暂不支持产品化配置，请勿使用。
http_method	string	健康检查器的HTTP请求方法。 取值为：CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT或TRACE。默认为GET。 此字段暂不支持产品化配置，请勿使用。
http_version	float	健康检查请求的HTTP版本。 取值为：1.0或1.1，默认是1.0。 此字段暂不支持产品化配置，请勿使用。
id	uuid	健康检查器的ID。
max_retries	integer	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
max_retries_down	integer	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
name	string	健康检查器的名称。
operating_status	string	健康检查器的运行状态。
pool_id	uuid	健康检查器关联的资源池ID。
project_id	string	健康检查器所属的项目ID。
provisioning_status	string	健康检查器的配置状态。
tags	list	标签。
timeout	integer	健康检查请求的超时时间（以秒为单位）。该值必须小于延迟值。
type	string	健康检查请求的协议类型。取值为：TCP、HTTP、PING、UDP-CONNECT。
updated_at	string	健康检查器最后一次更新的时间。
url_path	string	健康检查测试后端member健康时发送的http请求路径。必须是以正斜杠(/)开头的字符串。 此字段暂不支持产品化配置，请勿使用。

请求示例

curl -X GET -H "X-Auth-Token: <token>" http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/healthmonitors/a3490653-d64b-4ebb-9e64-3c3b7b899a61

正常响应示例

{
  "healthmonitor": {
    "id": "a3490653-d64b-4ebb-9e64-3c3b7b899a61",
    "name": "demo-hm",
    "type": "HTTP",
    "delay": 3000,
    "timeout": 4000,
    "max_retries": 3,
    "max_retries_down": 3,
    "http_method": "GET",
    "url_path": "/",
    "expected_codes": "200",
    "admin_state_up": true,
    "project_id": "250a86f0dcc9467285fa8af54457e885",
    "pools": [
      {
        "id": "fa549f85-fa3a-4280-bb2a-00b09285e6b3"
      }
    ],
    "provisioning_status": "ACTIVE",
    "operating_status": "ONLINE",
    "created_at": "2022-04-26T02:21:49",
    "updated_at": "2022-04-26T02:21:52",
    "tags": [],
    "http_version": null,
    "domain_name": null,
    "tenant_id": "250a86f0dcc9467285fa8af54457e885"
  }
}

正常响应代码

200

错误码

401，403，404，500

更新健康检查器

功能介绍

更新一个健康检查器。

接口约束

1. 如果该健康检查绑定的负载均衡器的状态不是运行中，不能更新该健康检查。

URI

PUT /v2.0/lbaas/healthmonitors/{healthmonitor_id}

参数	是否必选	描述
healthmonitor_id	是	待更新的健康检查器的ID。

请求消息

参数	参数类型	是否必选	描述
admin_state_up	boolean	否	健康检查器的管理状态。true表示启用，false表示停用
delay	integer	否	发送健康检查请求到成员的间隔时间，以秒为单位。
domain_name	string	否	发送健康检查请求的域名。 此字段暂不支持产品化配置，请勿使用。
expected_codes	string	否	HTTP状态代码列表，该列表期望从成员响应中声明它是健康的。
healthmonitor_id	uuid	是	健康检查器的ID。
http_method	string	否	健康检查器的HTTP请求方法。 取值为：CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT或TRACE。默认为GET。 此字段暂不支持产品化配置，请勿使用。
http_version	float	否	健康检查请求的HTTP版本。 取值为：1.0或1.1，默认是1.0。 此字段暂不支持产品化配置，请勿使用。
max_retries	integer	否	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
max_retries_down	integer	否	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
name	string	否	健康检查器的名称。
tags	list	否	标签。
timeout	integer	否	健康检查请求的超时时间（以秒为单位）。该值必须小于延迟值。
url_path	string	否	健康检查测试后端member健康时发送的http请求路径。必须是以正斜杠(/)开头的字符串。 此字段暂不支持产品化配置，请勿使用。

响应消息

参数	参数类型	描述
admin_state_up	boolean	资源的管理状态，默认是true。
created_at	string	资源创建的时间。
delay	integer	发送健康检查请求到成员的间隔时间，以秒为单位。
domain_name	string	发送健康检查请求的域名。 此字段暂不支持产品化配置，请勿使用。
expected_codes	string	HTTP状态代码列表，该列表期望从成员响应中声明它是健康的。
http_method	string	健康检查器的HTTP请求方法。 取值为：CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT或TRACE。默认为GET。 此字段暂不支持产品化配置，请勿使用。
http_version	float	健康检查请求的HTTP版本。 取值为：1.0或1.1，默认是1.0。 此字段暂不支持产品化配置，请勿使用。
id	uuid	健康检查器的ID。
max_retries	integer	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
max_retries_down	integer	将后端服务器member的健康检查状态置为ONLINE的连续检查成功次数。有效值是从1到10。
name	string	健康检查器的名称。
operating_status	string	健康检查器的运行状态。
pool_id	uuid	资源池的ID。
project_id	string	健康检查器所属的项目ID。
provisioning_status	string	健康检查器的配置状态。
tags	list	标签。
timeout	integer	健康检查请求的超时时间（以秒为单位）。该值必须小于延迟值。
type	string	健康检查请求的协议类型。取值为：TCP、HTTP、PING、UDP-CONNECT。
updated_at	string	资源最后一次更新的时间。
url_path	string	健康检查测试后端member健康时发送的http请求路径。必须是以正斜杠(/)开头的字符串。 此字段暂不支持产品化配置，请勿使用。

请求示例

curl -X PUT -H "X-Auth-Token: <token>" -d '{"healthmonitor": {"name": "demo-hm-2", "delay": 4, "timeout": 5, "max_retries": 6, "max_retries_down": 6}}' http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/healthmonitors/a3490653-d64b-4ebb-9e64-3c3b7b899a61

{
  "healthmonitor": {
    "name": "demo-hm-2",
    "delay": 4,
    "timeout": 5,
    "max_retries": 6,
    "max_retries_down": 6
  }
}

正常响应示例

{
  "healthmonitor": {
    "id": "a3490653-d64b-4ebb-9e64-3c3b7b899a61",
    "name": "demo-hm-2",
    "type": "HTTP",
    "delay": 4,
    "timeout": 5,
    "max_retries": 6,
    "max_retries_down": 6,
    "http_method": "GET",
    "url_path": "/",
    "expected_codes": "200",
    "admin_state_up": true,
    "project_id": "250a86f0dcc9467285fa8af54457e885",
    "pools": [
      {
        "id": "fa549f85-fa3a-4280-bb2a-00b09285e6b3"
      }
    ],
    "provisioning_status": "PENDING_UPDATE",
    "operating_status": "ONLINE",
    "created_at": "2022-04-26T02:21:49",
    "updated_at": "2022-04-26T02:27:14",
    "tags": [],
    "http_version": null,
    "domain_name": null,
    "tenant_id": "250a86f0dcc9467285fa8af54457e885"
  }
}

正常响应代码

202

错误码

400，401，403，404，409，500

健康检查器删除

功能介绍

删除健康检查器。

接口约束

URI

DELETE /v2.0/lbaas/healthmonitors/{healthmonitor_id}

参数	是否必选	描述
healthmonitor_id	是	待删除的健康检查器的ID。

请求消息

无

响应消息

无

请求示例

curl -X DELETE -H "X-Auth-Token: <token>" http://octavia-api.octavia.svc.cluster.local:9876/v2.0/lbaas/healthmonitors/a3490653-d64b-4ebb-9e64-3c3b7b899a61

正常响应示例

无

正常响应代码

202

错误码

400，401，403，404，409，500