clb — Cloud Load Balancer
clb · type
TargetGroupHealthCheck
17 fields
| Field | Type | Description |
|---|---|---|
| HealthSwitch | boolean | Whether to enable the health check. |
| Protocol | string | Health check method. among them, only the new version V2 target group type supports this parameter. valid values: TCP | HTTP | HTTPS | PING | CUSTOM. among them:. |
| Port | integer | Custom check parameters. health check port, defaults to the port of the backend service unless you want to specify a specific port, otherwise leave it blank. (applicable only to TCP/UDP target group). |
| Timeout | integer | Health check timeout. The default is 2 seconds. Value range: 2-30 seconds. |
| GapTime | integer | Detection interval time. The default is 5 seconds. Value range: 2-300 seconds. |
| GoodLimit | integer | Health detection threshold. The default is 3 times. Value range: 2-10 times. |
| BadLimit | integer | Unhealth detection threshold. The default is 3 times. Value range: 2-10 times. |
| JumboFrame | boolean | Indicates whether jumbo frames are enabled for probe packets of all rss in the target group. enabled by default. this parameter is supported only for GWLB type target groups. |
| HttpCode | integer | Health check status code (applicable only to HTTP/HTTPS target group and HTTP health check method of TCP target group). value range: 1~31. default: 31. among them: 1 means post-detection return value 1xx represents health. 2 means return 2xx represents health. 4 means return 3xx represents health. 8 means return 4xx represents health. 16 means return 5xx represents health. to have multiple retu… |
| HttpCheckDomain | string | Health check domain name. among them: applicable only to HTTP/HTTPS target groups and TCP target groups when using HTTP health check method. targeting HTTP/HTTPS target groups, this parameter is required when using HTTP health check method.. |
| HttpCheckPath | string | Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). |
| HttpCheckMethod | string | Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Default: HEAD. Valid values: HEAD and GET. |
| ContextType | string | Input format of health check. required when health check method is CUSTOM. valid values: HEX or TEXT. among them: TEXT: TEXT format. HEX: hexadecimal format. characters of SendContext and RecvContext can only be selected from 0123456789ABCDEF and the length must be an even number. applicable only to TCP/UDP target group.. |
| SendContext | string | CUSTOM check parameters. required when the CheckType value is CUSTOM, represents the content of the request sent by the health check, only ASCII visible characters, maximum length limit 500. applicable only to TCP/UDP target group. |
| RecvContext | string | CUSTOM check parameters. required when the CheckType value is CUSTOM. represents the result returned by the health check. only ASCII visible characters are allowed. maximum length limit is 500. (applicable only to TCP/UDP target group). |
| HttpVersion | string | HTTP version, where: this field is required if the value of CheckType is HTTP. supports configuration options: HTTP/1.0, HTTP/1.1. applicable only to TCP target group.. |
| ExtendedCode | string | Health check status code when the protocol is GRPC. (this parameter applies only to target groups with the backend forwarding protocol of GRPC.) default value: 12. valid values: a single numerical value, multiple numerical values, or a range. for example, 20, 20,25, or 0-99. |