CreateHealthCheckTemplate-阿里云帮助中心

Create a health check template in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alb:CreateHealthCheckTemplate

create

*HealthCheckTemplate

acs:alb:{#regionId}:{#accountId}:healthchecktemplate/*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can generate this token, but you must ensure that it is unique across requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system uses the `RequestId` of the request as the client token. Each API request has a unique `RequestId`.	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, must start with a letter, a digit, or a Chinese character, and can contain digits, periods (.), underscores (_), hyphens (-), and spaces.	HealthCheckTemplate1
HealthCheckConnectPort	integer	No	The port used for health checks. Valid values: 0 to 65535. Default value: 0. This value indicates that the port of a backend server is used for health checks.	80
HealthCheckHost	string	No	The domain name used for the health check. Valid values: $SERVER_IP: The private IP address of a backend server. If you set this parameter to `$SERVER_IP` or leave it empty, the load balancer uses the private IP address of the backend server as the domain name for the health check. 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 when the `HealthCheckProtocol` parameter is set to HTTP or HTTPS.	$SERVER_IP
HealthCheckCodes	array	No	The HTTP status codes that indicate a successful health check.	5
	string	No	The HTTP status codes that indicate a successful health check. If HealthCheckProtocol is set to HTTP or HTTPS, you can specify http_2xx (default), http_3xx, http_4xx, and http_5xx. You can specify multiple HTTP status codes. Separate them with commas (,). If HealthCheckProtocol is set to gRPC, the valid status codes are from 0 to 99. The default value is 0. You can specify up to 20 value ranges. Separate them with commas (,). Note This parameter takes effect only when the `HealthCheckProtocol` parameter is set to HTTP, HTTPS, or gRPC.	http_2xx
HealthCheckInterval	integer	No	The interval at which health checks are performed. Valid values: 1 to 50. Unit: seconds. Default value: 2. Unit: seconds.	2
HealthCheckTimeout	integer	No	The timeout period for a health check response. If a backend server does not respond within this period, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5. Unit: seconds.	5
HealthCheckPath	string	No	The URL that is used for health checks. The URL must be 1 to 80 characters in length. It must start with a forward slash (/) and can contain letters, digits, and the following special characters: `- / . % ? # & _;~!()[]@$^:',+`. Note* This parameter takes effect only when the `HealthCheckProtocol` parameter is set to HTTP or HTTPS.	/test/index.html
HealthCheckMethod	string	No	The method used for the health check. Valid values: HEAD (default): For HTTP and HTTPS listeners, the default health check method is HEAD. POST: For gRPC listeners, the default health check method is POST. GET: If the response body exceeds 8 KB, it is truncated. This does not affect the health check result. Note This parameter takes effect only when the `HealthCheckProtocol` parameter is set to HTTP, HTTPS, or gRPC.	HEAD
HealthCheckProtocol	string	No	The protocol used for the health check. Valid values: HTTP (default): simulates browser access by sending HEAD or GET requests to check whether the server application is healthy. HTTPS: simulates browser access by sending HEAD or GET requests to check whether the server application is healthy. HTTPS provides encrypted data transmission and is more secure than HTTP. TCP: checks whether the server port is responsive by sending SYN packets. gRPC: checks whether the server application is healthy by sending POST or GET requests.	HTTP
HealthCheckHttpVersion	string	No	The version of the HTTP protocol that is used for the health check. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. Note This parameter takes effect only when the `HealthCheckProtocol` parameter is set to HTTP or HTTPS.	HTTP 1.0
HealthyThreshold	integer	No	The number of consecutive successful health checks required to change the health status of a backend server from unhealthy to healthy. Valid values: 2 to 10. Default value: 3.	4
UnhealthyThreshold	integer	No	The number of consecutive failed health checks required to change the health status of a backend server from healthy to unhealthy. Valid values: 2 to 10. Default value: 3.	4
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the request for potential issues, including missing required parameters, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. The resource is not created. false (default): Sends a normal request. If the request is valid, a 2xx HTTP status code is returned and the health check template is created.	true
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key. The tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	env
Value	string	No	The tag value. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and 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 object.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.