vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/elb/api-ref/UpdateHealthMonitor.rst

42 KiB
Raw Blame History

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.

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 Upda teHealthMonitorOption <#UpdateHealthMonit or__request_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. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true
delay No Integer

Specifies the interval between health checks, in seconds.

Minimum: 1

Maximum: 50
domain_name No String

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

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

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.

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

Minimum: 1

Maximum: 100
expected_codes No String

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

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

This parameter is unsupported. Please do not use it.

Default: 200

Minimum: 1

Maximum: 64
http_method No String

Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. This parameter will take effect only when type is set to HTTP.

This parameter is unsupported. Please do not use it.

Default: GET

Minimum: 1

Maximum: 16
max_retries No Integer

Specifies the maximum health check retries.

Minimum: 1

Maximum: 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.

Minimum: 1

Maximum: 10
monitor_port No Integer

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

Minimum: 1

Maximum: 65535
name No String

Specifies the health check name.

Minimum: 0

Maximum: 255
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.

Minimum: 1

Maximum: 50
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 /. This parameter is available only when type is set to HTTP.

Default: /

Minimum: 1

Maximum: 255
type No String

Specifies the protocol used for the health check.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

Response Parameters

Status code: 200

Table 5 Response body parameters
Parameter Type Description
request_id String Specifies the request ID. The value is automatically generated.
healthmonitor HealthMonitor <# UpdateHealthMonitor__response_HealthMonitor>__ object Specifies the health check.
Table 6 HealthMonitor
Parameter Type Description
admin_state_up Boolean

Specifies the administrative status of the health check. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true
delay Integer

Specifies the interval between health checks, in seconds.

Minimum: 1

Maximum: 50
domain_name String

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

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

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.

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

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

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

This parameter is unsupported. Please do not use it.

Default: 200
http_method String

Specifies the HTTP method. This parameter will take effect only when type is set to HTTP.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter is unsupported. Please do not use it.

Default: GET
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.

Minimum: 1

Maximum: 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.

Minimum: 1

Maximum: 10

Default: 3
monitor_port Integer

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

Minimum: 1

Maximum: 65535
name String Specifies the health check name.
pools Array of PoolRef <#Upda teHealthMonitor__response_PoolRef>__ objects Lists the IDs of backend server groups for which the health check is configured.
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.

Minimum: 1

Maximum: 50
type String Specifies the health check protocol.
url_path String

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

Default: /
Table 7 PoolRef
Parameter Type Description
id String Specifies the ID of the backend server group.

Example Requests

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" : {
    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "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"
  }
}

Status Codes

Status Code Description
200 Successful request.

Error Codes

See Error Codes.

Parent topic: Health Check