Creates a health check template in a specified region.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
alb:CreateHealthCheckTemplate |
create |
*HealthCheckTemplate
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. Generate a parameter value on your client to ensure that the value is unique across different requests. The ClientToken parameter supports only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique. |
5A2CFF0E-5718-45B5-9D4D-70B****** |
| HealthCheckTemplateName |
string |
Yes |
The name of the health check template. The name must be 2 to 128 characters in length. It must start with a letter, Chinese character, or digit, and can contain letters, Chinese characters, digits, periods (.), underscores (_), hyphens (-), and spaces. |
HealthCheckTemplate1 |
| HealthCheckConnectPort |
integer |
No |
The port used for health checks. Valid values: 0 to 65535. Default value: 0, which indicates that the port of the backend server is used for health checks. |
80 |
| HealthCheckHost |
string |
No |
The domain name used for health checks. Valid values:
Note
This parameter takes effect only when |
$SERVER_IP |
| HealthCheckCodes |
array |
No |
The list of normal status codes for health checks. |
5 |
|
string |
No |
The normal HTTP status codes for health checks.
Note
This parameter is available only when HealthCheckProtocol is set to HTTP, HTTPS, or gRPC. |
http_2xx |
|
| HealthCheckInterval |
integer |
No |
The interval between health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2. |
2 |
| HealthCheckTimeout |
integer |
No |
The timeout period for receiving a response from a health check. If the backend server does not respond within the specified timeout period, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5. |
5 |
| HealthCheckPath |
string |
No |
The URL used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), ampersands (&), and the following extended characters: Note
This parameter is available only when |
/test/index.html |
| HealthCheckMethod |
string |
No |
The health check method. Valid values:
Note
This parameter is available only when HealthCheckProtocol is set to HTTP, HTTPS, or gRPC. |
HEAD |
| HealthCheckProtocol |
string |
No |
The protocol used for health checks. Valid values:
|
HTTP |
| HealthCheckHttpVersion |
string |
No |
The HTTP version for health checks. Valid values: HTTP 1.0 and HTTP 1.1. Default value: HTTP 1.1. Note
This parameter is available only when |
HTTP 1.0 |
| HealthyThreshold |
integer |
No |
The number of consecutive successful health checks that must occur before the health check status of a backend server changes from Failed to Successful. Valid values: 2 to 10. Default value: 3. |
4 |
| UnhealthyThreshold |
integer |
No |
The number of consecutive failed health checks that must occur before the health check status of a backend server changes from Successful to Failed. Valid values: 2 to 10. Default value: 3. |
4 |
| DryRun |
boolean |
No |
Specifies whether to only precheck the request. Valid values:
|
true |
| Tag |
array<object> |
No |
The tags. |
|
|
object |
No |
The tag structure. |
||
| Key |
string |
No |
The tag key. The key can be up to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://. |
env |
| Value |
string |
No |
The tag value. The value can be up to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://. |
product |
| ResourceGroupId |
string |
No |
The ID of the resource group. |
rg-atstuj3rtop**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The health check template. |
||
| HealthCheckTemplateId |
string |
The ID of the health check template. |
hct-pno8sisi****** |
| RequestId |
string |
The ID of the request. |
365F4154-92F6-4AE4-92F8-7FF34****** |
Examples
Success response
JSON format
{
"HealthCheckTemplateId": "hct-pno8sisi******",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | QuotaExceeded.HealthCheckTemplatesNum | The quota of %s is exceeded, usage %s/%s. | The quota of %s is exceeded. Usage: %s/%s. |
| 403 | Forbidden.HealthCheckTemplate | Authentication has failed for HealthCheckTemplate. | Authentication failed for the HealthCheckTemplate. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.