| object | | |
| HealthCheckConnectPort | integer | The port that is used for health checks.
Valid values: 0 to 65535. | 80 |
| HealthCheckHost | string | The domain name that is used for health checks. Valid values:
- $SERVER_IP: the private IP addresses of backend servers. If an IP address is specified, or this parameter is not specified, the ALB instance uses the private IP addresses of backend servers as domain names for health checks.
- domain: The domain name must be 1 to 80 characters in length, and can contain letters, digits, periods (.), and hyphens (-).
Note
This parameter takes effect only if HealthCheckProtocol is set to HTTP or HTTPS.
| $SERVER_IP |
| HealthCheckCodes | array | The HTTP status codes that indicate a healthy backend server. | |
| string | The HTTP status code that indicates a healthy backend server.
- If HealthCheckProtocol is set to HTTP or HTTPS, you can set HealthCheckCodes to http_2xx (default), http_3xx, http_4xx, or http_5xx. Separate multiple status codes with commas (,).
- If HealthCheckProtocol is set to gRPC, the valid values of HealthCheckCodes are from 0 to 99. The default value is 0. Value ranges are supported. You can enter at most 20 value ranges. Separate multiple value ranges with commas (,).
Note
This parameter takes effect only if you set HealthCheckProtocol to HTTP, HTTPS, or gRPC.
| http_2xx,http_3xx |
| HealthCheckHttpVersion | string | The HTTP version for health checks.
Valid values: HTTP1.0 and HTTP1.1.
Note
This parameter takes effect only if you set HealthCheckProtocol to HTTP or HTTPS.
| HTTP1.0 |
| HealthCheckTemplateId | string | The ID of the health check template. | hct-x4jazoyi6tvsq9**** |
| HealthCheckInterval | integer | The interval at which health checks are performed. Unit: seconds. Valid values: 1 to 50. | 3 |
| HealthCheckMethod | string | The HTTP method that is used for health checks. Valid values:
- HEAD (default): By default, HTTP and HTTPS health checks use the HEAD method.
- GET: If the length of a response exceeds 8 KB, the response is truncated. However, the health check result is not affected.
- POST: gRPC health checks use the POST method by default.
Note
This parameter takes effect only if you set HealthCheckProtocol to HTTP, HTTPS, or gRPC.
| GET |
| HealthCheckPath | string | The URL that is used for health checks.
The URL must be 1 to 80 characters in length, and can contain letters, digits, the following special characters: - / . % ? # &, and the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/).
Note
This parameter takes effect only if you set HealthCheckProtocol to HTTP, HTTPS, or gRPC.
| /test/index.html |
| HealthCheckProtocol | string | The protocol that is used for health checks. Valid values:
- HTTP (default): HTTP health checks simulate browser behaviors by sending HEAD or GET requests to probe the availability of backend servers.
- HTTPS: The ALB instance sends HEAD or GET requests, which simulate browser requests, to check whether the backend server is healthy. HTTPS supports encryption and provides higher security than HTTP.
- TCP: TCP health checks send TCP SYN packets to a backend server to probe the availability of backend servers.
- gRPC: gRPC health checks send POST or GET requests to a backend server to probe the availability of backend servers.
| HTTP |
| HealthCheckTemplateName | string | The name of the health check template.
The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter. | HealthCheckTemplate1 |
| HealthCheckTimeout | integer | The timeout period of a health check. If a backend server does not respond within the specified timeout period, the backend server fails the health check. Unit: seconds.
Valid values: 1 to 300.
Note
If the value of the HealthCheckTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckTimeout parameter is ignored and the value of the HealthCheckInterval parameter is used as the timeout period.
| 200 |
| HealthyThreshold | integer | The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success.
Valid values: 2 to 10. | 5 |
| RequestId | string | | DB1AFC33-DAE8-528E-AA4D-4A6AABE71945 |
| UnhealthyThreshold | integer | The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail.
Valid values: 2 to 10. | 5 |
| Tags | array<object> | | |
| object | | |
| Key | string | The tag key. The tag key can be up to 128 characters in length, and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun. | env |
| Value | string | The tag value. The tag value can be up to 128 characters in length, and cannot start with acs:. The tag value cannot contain http:// or https://. | product |
