更新时间:2024-04-08 GMT+08:00

创建健康检查

功能介绍

为后端云服务器添加健康检查配置。

URI

POST /v1.0/{project_id}/elbaas/healthcheck

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

操作用户的项目ID。

listener_id

String

健康检查所属Listener ID。

healthcheck_protocol

String

  • 健康检查协议。当负载均衡类型为私网时,不允许创建UDP协议的健康检查。
  • 取值范围:HTTP/TCP/UDP。

healthcheck_uri

String

  • 用于健康检查的URI。healthcheck_protocol为HTTP时生效。
  • 取值范围:长度限制为1-80字符,必须以‘/’开头。只能使用字母、数字、‘-’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、“_”、“=”这些字符。

healthcheck_connect_port

Integer

  • 进行健康检查时使用的端口。
  • 取值范围:1-65535个字符。

healthy_threshold

Integer

  • 判定健康检查结果为success的阈值。即,健康检查连续成功多少次后,将后端云服务器的健康检查结果由fail改为success。
  • 取值范围:1-10个字符。

unhealthy_threshold

Integer

  • 判定健康检查结果为fail的阈值。即,健康检查连续失败多少次后,将后端云服务器的健康检查状态由success改为fail。
  • 取值范围:1-10个字符。

healthcheck_timeout

Integer

  • 每次健康检查响应的最大超时时间。
  • 取值范围:1-50(s)。

healthcheck_interval

Integer

  • 每次健康检查响应的最大间隔时间。
  • 取值范围:1-50(s)。

请求消息

  • 请求参数

  • 请求样例1 创建HTTP健康检查
    {
        "healthcheck_connect_port": 80,
        "healthcheck_interval": 5,
        "healthcheck_protocol": "HTTP",
        "healthcheck_timeout": 10,
        "healthcheck_uri": "/",
        "healthy_threshold": 3,
        "listener_id": "3ce8c4429478a5eb6ef4930de2d75b28",
        "unhealthy_threshold": 3
    }
  • 请求样例2 创建TCP健康检查
    {
        "healthcheck_connect_port": 80,
        "healthcheck_interval": 5,
        "healthcheck_protocol": "TCP",
        "healthcheck_timeout": 10,
        "healthcheck_uri": "",
        "healthy_threshold": 3,
        "listener_id": "3ce8c4429478a5eb6ef4930de2d75b28",
        "unhealthy_threshold": 3
    }

响应消息

  • 响应参数
    表2 响应参数

    参数

    参数类型

    描述

    healthcheck_interval

    Integer

    每次健康检查响应的最大间隔时间。

    listener_id

    String

    健康检查所属ListenerID。

    id

    String

    健康检查ID。

    healthcheck_protocol

    String

    健康检查协议。

    unhealthy_threshold

    Integer

    判定健康检查结果为fail的阈值。即,健康检查连续失败多少次后,将后端云服务器的健康检查状态由success改为fail。

    update_time

    String

    更新时间。

    create_time

    String

    创建时间。

    healthcheck_connect_port

    Integer

    进行健康检查时使用的端口。

    healthcheck_timeout

    Integer

    每次健康检查响应的最大超时时间。

    healthcheck_uri

    String

    用于健康检查的URI。healthcheck_protocol为HTTP时生效。

    healthy_threshold

    Integer

    判定健康检查结果为success的阈值。即,健康检查连续成功多少次后,将后端云服务器的健康检查结果由fail改为success。

  • 响应样例1 创建HTTP健康检查
    {
         "healthcheck_interval":5,
         "listener_id":"3ce8c4429478a5eb6ef4930de2d75b28",
         "id":"134e5ea962327c6a574b83e6e7f31f35",
         "healthcheck_protocol":"HTTP",
         "unhealthy_threshold":3,
         "update_time":"2015-12-25 03:57:23",
         "create_time":"2015-12-25 03:57:23",
         "healthcheck_connect_port":80,
         "healthcheck_timeout":10,
         "healthcheck_uri":"\/",
         "healthy_threshold":3
    }
  • 响应样例2 创建TCP健康检查
    {
         "healthcheck_interval":5,
         "listener_id":"3ce8c4429478a5eb6ef4930de2d75b28",
         "id":"134e5ea962327c6a574b83e6e7f31f35",
         "healthcheck_protocol":"TCP",
         "unhealthy_threshold":3,
         "update_time":"2015-12-25 03:57:23",
         "create_time":"2015-12-25 03:57:23",
         "healthcheck_connect_port":80,
         "healthcheck_timeout":10,
         "healthcheck_uri":"",
         "healthy_threshold":3
    }

状态码

  • 正常

    200

  • 异常

    状态码

    编码

    错误码说明

    400

    badRequest

    请求错误

    401

    unauthorized

    鉴权失败

    403

    userDisabled

    没有权限

    404

    Not Found

    请求的页面不存在

    500

    authFault

    内部错误

    503

    serviceUnavailable

    服务不可用