All Products
Search
Document Center

API Gateway:ServiceHealthCheck

Last Updated:Jun 30, 2026

Parameter

Type

Description

Example

object

The service health check configuration.

protocol

string

The health check protocol. Valid values: TCP, HTTP, and GRPC.

TCP

timeout

integer

The health check response timeout period.

interval

integer

The health check interval.

healthyThreshold

integer

The healthy threshold for health check.

unhealthyThreshold

integer

The unhealthy threshold for health check.

httpPath

string

The health check path. This parameter is required when the health check protocol is HTTP.

httpHost

string

The health check domain name. This parameter is optional when the health check protocol is HTTP.

enable

boolean

Specifies whether to enable the health check.

true