更新时间:2024-09-26 GMT+08:00

创建健康检查

功能介绍

创建健康检查。

接口约束

1.安全组需放通网段100.125.0.0/16流量。

2.UDP的检查健康只能使用在UDP的后端服务器组上。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/elb/healthmonitors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token.。

表3 请求Body参数

参数

是否必选

参数类型

描述

healthmonitor

CreateHealthMonitorOption object

健康检查对象。

表4 CreateHealthMonitorOption

参数

是否必选

参数类型

描述

admin_state_up

Boolean

参数解释:健康检查的管理状态。

取值范围:

  • true:表示开启健康检查。

  • false表示关闭健康检查。

默认取值:true

delay

Integer

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

domain_name

String

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

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

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

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

expected_codes

String

期望响应状态码。

取值:

  • 单值:单个返回码,例如200。

  • 列表:多个特定返回码,例如200,202。

  • 区间:一个返回码区间,例如200-204。

默认值:若健康检查type为GRPC,则默认值为0,;其他为200。

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

http_method

String

HTTP请求方法。

取值:GET、HEAD、POST,默认GET。

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

max_retries

Integer

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

max_retries_down

Integer

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

monitor_port

Integer

健康检查端口号。取值:1-65535,默认为空,表示使用后端服务器端口号。

说明:

当绑定的pool开启了端口透传功能时,该字段为必填。

name

String

健康检查名称。

pool_id

String

健康检查所在的后端服务器组ID

project_id

String

健康检查所在的项目ID。

timeout

Integer

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

建议该值小于delay的值。

type

String

健康检查请求协议。

取值:TCP、UDP_CONNECT、HTTP、HTTPS、GRPC和TLS。

使用说明:

  • 若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、TLS、GRPC。

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

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

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

url_path

String

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

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

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

响应参数

状态码: 201

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

注:自动生成 。

healthmonitor

HealthMonitor object

健康检查对象。

表6 HealthMonitor

参数

参数类型

描述

admin_state_up

Boolean

健康检查的管理状态。

取值范围:

  • true:表示开启健康检查。

  • false表示关闭健康检查。

默认取值:true。

delay

Integer

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

domain_name

String

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

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

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

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

expected_codes

String

期望响应状态码。

取值:

  • 单值:单个返回码,例如200。

  • 列表:多个特定返回码,例如200,202。

  • 区间:一个返回码区间,例如200-204。

默认值:若健康检查type为GRPC,则默认值为0,;其他为200。

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

http_method

String

HTTP请求方法。

取值:GET、HEAD、POST,默认GET。

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

id

String

健康检查ID

max_retries

Integer

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

max_retries_down

Integer

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

monitor_port

Integer

健康检查端口号。取值:1-65535,默认为空,表示使用后端服务器端口号。

name

String

健康检查名称。

pools

Array of PoolRef objects

健康检查所在的后端服务器组ID列表。实际只会有一个后端服务器组ID。

project_id

String

健康检查所在的项目ID。

timeout

Integer

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

建议该值小于delay的值。

type

String

健康检查请求协议。

取值:TCP、UDP_CONNECT、HTTP、HTTPS、TLS和GRPC。

使用说明:

  • 若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、TLS、GRPC。

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

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

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

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

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

表7 PoolRef

参数

参数类型

描述

id

String

参数解释:后端服务器组ID。

请求示例

创建健康检查,并指定检查协议为HTTP协议

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

{
  "healthmonitor" : {
    "name" : "My Healthmonitor",
    "max_retries" : 3,
    "pool_id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0",
    "type" : "HTTP",
    "timeout" : 30,
    "delay" : 1
  }
}

响应示例

状态码: 201

POST操作正常返回。

{
  "request_id" : "0e837340-f1bd-4037-8f61-9923d0f0b19e",
  "healthmonitor" : {
    "monitor_port" : null,
    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "domain_name" : null,
    "name" : "My Healthmonitor",
    "delay" : 1,
    "max_retries" : 3,
    "pools" : [ {
      "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0"
    } ],
    "admin_state_up" : true,
    "timeout" : 30,
    "type" : "HTTP",
    "expected_codes" : "200",
    "url_path" : "/",
    "http_method" : "GET"
  }
}

SDK代码示例

SDK代码示例如下。

创建健康检查,并指定检查协议为HTTP协议

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;


public class CreateHealthMonitorSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateHealthMonitorRequest request = new CreateHealthMonitorRequest();
        CreateHealthMonitorRequestBody body = new CreateHealthMonitorRequestBody();
        CreateHealthMonitorOption healthmonitorbody = new CreateHealthMonitorOption();
        healthmonitorbody.withDelay(1)
            .withMaxRetries(3)
            .withName("My Healthmonitor")
            .withPoolId("488acc50-6bcf-423d-8f0a-0f4184f5b8a0")
            .withTimeout(30)
            .withType("HTTP");
        body.withHealthmonitor(healthmonitorbody);
        request.withBody(body);
        try {
            CreateHealthMonitorResponse response = client.createHealthMonitor(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

创建健康检查,并指定检查协议为HTTP协议

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateHealthMonitorRequest()
        healthmonitorbody = CreateHealthMonitorOption(
            delay=1,
            max_retries=3,
            name="My Healthmonitor",
            pool_id="488acc50-6bcf-423d-8f0a-0f4184f5b8a0",
            timeout=30,
            type="HTTP"
        )
        request.body = CreateHealthMonitorRequestBody(
            healthmonitor=healthmonitorbody
        )
        response = client.create_health_monitor(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建健康检查,并指定检查协议为HTTP协议

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateHealthMonitorRequest{}
	nameHealthmonitor:= "My Healthmonitor"
	healthmonitorbody := &model.CreateHealthMonitorOption{
		Delay: int32(1),
		MaxRetries: int32(3),
		Name: &nameHealthmonitor,
		PoolId: "488acc50-6bcf-423d-8f0a-0f4184f5b8a0",
		Timeout: int32(30),
		Type: "HTTP",
	}
	request.Body = &model.CreateHealthMonitorRequestBody{
		Healthmonitor: healthmonitorbody,
	}
	response, err := client.CreateHealthMonitor(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

POST操作正常返回。

错误码

请参见错误码