Viewing the Details of a Health Check

project_id

Yes

String

Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints: N/A

Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

Default value: N/A

healthmonitor_id

Yes

String

Definition: Specifies the health check ID.

Constraints: N/A

Range: N/A

Default value: N/A

X-Auth-Token

Yes

String

Definition: Specifies the token used for IAM authentication.

Constraints: N/A

Range: N/A

Default value: N/A

request_id

String

Definition: Specifies the request ID.

Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).

healthmonitor

HealthMonitor object

Definition: Specifies the health check.

admin_state_up

Boolean

Definition: Specifies the administrative status of the health check.

Range:

• true: The health check function is enabled.

• false: The health check function is disabled.

delay

Integer

Definition: Specifies the interval between health checks, in seconds.

Range: 1 to 50

domain_name

String

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

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

expected_codes

String

Definition: Specifies the expected HTTP status code.

Range:

• 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

http_method

String

Definition: Specifies the HTTP method.

Range: GET, HEAD, or POST

id

String

Specifies the health check ID.

Default value: N/A

max_retries

Integer

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

Range: 1 to 10

max_retries_down

Integer

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

Range: 1 to 10

monitor_port

Integer

Definition: Specifies the health check port.

Range: 1 to 65535, or null (the port of a backend server will be used by default).

name

String

Definition: Specifies the health check name.

Range: N/A

pools

Array of PoolRef objects

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

Range: N/A

project_id

String

Definition: Specifies the project ID.

Range: N/A

timeout

Integer

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

Range: N/A

type

String

Definition: Specifies the health check protocol.

Range: The value can be TCP, UDP_CONNECT, HTTP, HTTPS, GRPC, or TLS.

url_path

String

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

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

created_at

String

Definition: Specifies the creation time.

Range: The value must be a UTC time in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

updated_at

String

Definition: Specifies the update time.

Range: The value must be a UTC time in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

id

String

Definition: Specifies the backend server group ID.

Range: N/A

200

Successful request.