GetHealthCheckTemplateAttribute - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the details about a health check template.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alb:GetHealthCheckTemplateAttribute	get	HealthCheckTemplate acs:alb:{#regionId}:{#accountId}:healthchecktemplate/{#healthchecktemplateId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
HealthCheckTemplateId	string	Yes	The ID of the health check template.	hct-x4jazoyi6tvsq9****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
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.
HealthCheckCode	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 response. If a backend server does not respond within the specified timeout period, the backend server is declared unhealthy. Unit: seconds. Valid values: 1 to 300.	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	The request ID.	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>	The tags.
Tag	object	The tags.
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

Examples

Sample success responses

JSONformat

{
  "HealthCheckConnectPort": 80,
  "HealthCheckHost": "$SERVER_IP",
  "HealthCheckCodes": [
    "http_2xx,http_3xx"
  ],
  "HealthCheckHttpVersion": "HTTP1.0",
  "HealthCheckTemplateId": "hct-x4jazoyi6tvsq9****",
  "HealthCheckInterval": 3,
  "HealthCheckMethod": "GET",
  "HealthCheckPath": "/test/index.html",
  "HealthCheckProtocol": "HTTP",
  "HealthCheckTemplateName": "HealthCheckTemplate1",
  "HealthCheckTimeout": 200,
  "HealthyThreshold": 5,
  "RequestId": "DB1AFC33-DAE8-528E-AA4D-4A6AABE71945",
  "UnhealthyThreshold": 5,
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.	-
404	ResourceNotFound.HealthCheckTemplate	The specified resource %s is not found.	The specified resource %s is not found.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-18	The Error code has changed	View Change Details