Updated on 2024-09-26 GMT+08:00

Updating a Health Check

Function

This API is used to update a health check.

Constraints

The health check can be updated only when the provisioning status of the associated load balancer is ACTIVE.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

healthmonitor_id

Yes

String

Specifies the health check ID.

project_id

Yes

String

Specifies the project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the token used for IAM authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

healthmonitor

Yes

UpdateHealthMonitorOption object

Specifies the health check.

Table 4 UpdateHealthMonitorOption

Parameter

Mandatory

Type

Description

admin_state_up

No

Boolean

Specifies the administrative status of the health check.

The value can be true (health check enabled) or false (health check disabled).

delay

No

Integer

Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

domain_name

No

String

Specifies the domain name that HTTP requests are sent to during the health check.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

The value cannot be left blank, but can be specified as null or cannot be passed, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

This parameter is available only when type is set to HTTP or HTTPS.

expected_codes

No

String

Specifies the expected HTTP status code.

The value options are as follows:

  • A specific value, for example, 200

  • A list of values that are separated with commas (,), for example, 200, 202

  • A value range, for example, 200-204

If type is set to gRPC, the default value is 0. If type is set to other protocols, the default value is 200.

This parameter will take effect only when type is set to HTTP, HTTPS or gRPC.

http_method

No

String

Specifies the HTTP method. The value can be GET, HEAD, or POST. The default value is GET.

This parameter is available when type is set to HTTP or HTTPS.

This parameter is unsupported. Please do not use it.

max_retries

No

Integer

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

max_retries_down

No

Integer

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

monitor_port

No

Integer

Specifies the port used for the health check. This parameter cannot be left blank, but can be set to null, indicating that the port used by the backend server will be used. The port number ranges from 1 to 65535.

name

No

String

Specifies the health check name.

timeout

No

Integer

Specifies the maximum time required for waiting for a response from the health check, in seconds.

It is recommended that you set the value less than that of parameter delay.

url_path

No

String

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

The value can contain letters, digits, hyphens (-), slashes (/), periods (.), percentage signs (%), question marks (?), pound signs (#), ampersand signs (&), and the extended character set _;~!()*[]@$^:',+.

Note: This parameter is available only when type is set to HTTP or HTTPS.

type

No

String

Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, HTTPS, gRPC or TLS.

Note:

  • If the protocol of the backend server is QUIC, the value can only be UDP_CONNECT.

  • If the protocol of the backend server is UDP, the value can only be UDP_CONNECT.

  • If the protocol of the backend server is TCP, the value can only be TCP, HTTP or HTTPS.

  • If the protocol of the backend server is HTTP, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

  • If the protocol of the backend server is HTTPS, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

  • If the protocol of the backend server is gRPC, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

  • If the protocol of the backend server is TLS, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Note: The value is automatically generated.

healthmonitor

HealthMonitor object

Specifies the health check.

Table 6 HealthMonitor

Parameter

Type

Description

admin_state_up

Boolean

Specifies the administrative status of the health check.

The value can be:

  • true (default): Health check is enabled.

  • false: Health check is disabled.

delay

Integer

Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

domain_name

String

Specifies the domain name that HTTP requests are sent to during the health check.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

This parameter is available only when type is set to HTTP or HTTPS.

expected_codes

String

Specifies the expected HTTP status code.

The value options are as follows:

  • A specific value, for example, 200

  • A list of values that are separated with commas (,), for example, 200, 202

  • A value range, for example, 200-204

If type is set to gRPC, the default value is 0. If type is set to other protocols, the default value is 200.

This parameter will take effect only when type is set to HTTP, HTTPS or gRPC.

http_method

String

Specifies the HTTP method. The value can be GET, HEAD, or POST. The default value is GET.

This parameter is available when type is set to HTTP or HTTPS.

This parameter is unsupported. Please do not use it.

id

String

Specifies the health check ID.

max_retries

Integer

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

max_retries_down

Integer

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10, and the default value is 3.

monitor_port

Integer

Specifies the port used for the health check.

This parameter is left blank by default, indicating that a port of the backend server will be used by default. The port number ranges from 1 to 65535.

name

String

Specifies the health check name.

pools

Array of PoolRef objects

Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

project_id

String

Specifies the project ID.

timeout

Integer

Specifies the maximum time required for waiting for a response from the health check, in seconds.

It is recommended that you set the value less than that of parameter delay.

type

String

Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, HTTPS, gRPC or TLS.

Note:

  • If the protocol of the backend server is QUIC, the value can only be UDP_CONNECT.

  • If the protocol of the backend server is UDP, the value can only be UDP_CONNECT.

  • If the protocol of the backend server is TCP, the value can only be TCP, HTTP or HTTPS.

  • If the protocol of the backend server is HTTP, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

  • If the protocol of the backend server is HTTPS, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

  • If the protocol of the backend server is gRPC, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

  • If the protocol of the backend server is TLS, the value can only be TCP, HTTP, HTTPS, gRPC, or TLS.

url_path

String

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

The value can contain letters, digits, hyphens (-), slashes (/), periods (.), percentage signs (%), question marks (?), pound signs (#), ampersand signs (&), and the extended character set _;~!()*[]@$^:',+.

Note: This parameter is available only when type is set to HTTP or HTTPS.

created_at

String

Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

updated_at

String

Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

Table 7 PoolRef

Parameter

Type

Description

id

String

Specifies the ID of the backend server group.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

-

Integer

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

-

Integer

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

-

Integer

Status code: 409

Table 11 Response body parameters

Parameter

Type

Description

-

Integer

Status code: 431

Table 12 Response body parameters

Parameter

Type

Description

-

Integer

Status code: 494

Table 13 Response body parameters

Parameter

Type

Description

-

Integer

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

-

Integer

Example Requests

Modifying the interval between health checks

PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors/c2b210b2-60c4-449d-91e2-9e9ea1dd7441

{
  "healthmonitor" : {
    "name" : "My Healthmonitor update",
    "max_retries" : 10,
    "delay" : 10
  }
}

Example Responses

Status code: 200

Successful request.

{
  "request_id" : "08d6ffea-d092-4cfa-860a-e364f3bef1be",
  "healthmonitor" : {
    "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"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Modifying the interval between health checks

 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
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 UpdateHealthMonitorSolution {

    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();
        UpdateHealthMonitorRequest request = new UpdateHealthMonitorRequest();
        request.withHealthmonitorId("{healthmonitor_id}");
        UpdateHealthMonitorRequestBody body = new UpdateHealthMonitorRequestBody();
        UpdateHealthMonitorOption healthmonitorbody = new UpdateHealthMonitorOption();
        healthmonitorbody.withDelay(10)
            .withMaxRetries(10)
            .withName("My Healthmonitor update");
        body.withHealthmonitor(healthmonitorbody);
        request.withBody(body);
        try {
            UpdateHealthMonitorResponse response = client.updateHealthMonitor(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());
        }
    }
}

Modifying the interval between health checks

 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
# 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 = UpdateHealthMonitorRequest()
        request.healthmonitor_id = "{healthmonitor_id}"
        healthmonitorbody = UpdateHealthMonitorOption(
            delay=10,
            max_retries=10,
            name="My Healthmonitor update"
        )
        request.body = UpdateHealthMonitorRequestBody(
            healthmonitor=healthmonitorbody
        )
        response = client.update_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)

Modifying the interval between health checks

 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.UpdateHealthMonitorRequest{}
	request.HealthmonitorId = "{healthmonitor_id}"
	delayHealthmonitor:= int32(10)
	maxRetriesHealthmonitor:= int32(10)
	nameHealthmonitor:= "My Healthmonitor update"
	healthmonitorbody := &model.UpdateHealthMonitorOption{
		Delay: &delayHealthmonitor,
		MaxRetries: &maxRetriesHealthmonitor,
		Name: &nameHealthmonitor,
	}
	request.Body = &model.UpdateHealthMonitorRequestBody{
		Healthmonitor: healthmonitorbody,
	}
	response, err := client.UpdateHealthMonitor(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful request.

400

Invalid request body or request parameters.

403

Failed to verify the token.

404

The queried resource does not exist.

409

A conflict occurred.

431

The request headers are too large.

494

The request header or cookie is too large.

500

A service error occurred.

Error Codes

See Error Codes.