All Products
Search

This Product

    Server Load Balancer:UpdateHealthCheckTemplateAttribute

    Document Center

    Server Load Balancer:UpdateHealthCheckTemplateAttribute

    Last Updated:Jul 26, 2024

    Modifies the attributes, such as the name and protocol, of 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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    alb:UpdateHealthCheckTemplateAttributeupdate
    • HealthCheckTemplate
      acs:alb:{#regionId}:{#accountId}:healthchecktemplate/{#healthchecktemplateId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    HealthCheckTemplateNamestringNo

    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
    HealthCheckConnectPortintegerNo

    The port that is 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
    HealthCheckHoststringNo

    The domain name that is used for health checks. Valid values:

    • $SERVER_IP (default): the private IP address of a backend server. 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 is available only if HealthCheckProtocol is set to HTTP or HTTPS.
    		$_ip
    HealthCheckCodesarrayNo

    The HTTP status codes that indicate a healthy backend server.

    stringNo

    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 is available only if you set HealthCheckProtocol to HTTP, HTTPS, or gRPC.
    		http_2xx,http_3xx
    HealthCheckIntervalintegerNo

    The interval at which health checks are performed. Unit: seconds. Valid values: 1 to 50. Default value: 2.

    		5
    HealthCheckTimeoutintegerNo

    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. Default value: 5.

    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.
    		3
    HealthCheckPathstringNo

    The URL that is 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 character sets: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , +.

    The URL must start with a forward slash (/).

    Note This parameter is available only if you set HealthCheckProtocol to HTTP, HTTPS, or gRPC.
    		/test/index.html
    HealthCheckMethodstringNo

    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 is available only if you set HealthCheckProtocol to HTTP, HTTPS, or gRPC.
    		HEAD
    HealthCheckProtocolstringNo

    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 check whether the port of the backend server is reachable.
    • gRPC: gRPC health checks send POST or GET requests to a backend server to check whether the backend server is healthy.
    		HTTP
    HealthCheckHttpVersionstringNo

    The HTTP version that is used for health checks.

    Valid values: HTTP1.0 and HTTP1.1.

    Default value: HTTP1.1.

    Note This parameter is available only if you set HealthCheckProtocol to HTTP or HTTPS.
    		HTTP1.0
    HealthyThresholdintegerNo

    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.

    Default value: 3.

    		4
    UnhealthyThresholdintegerNo

    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.

    Default value: 3.

    		4
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		true
    HealthCheckTemplateIdstringYes

    The template ID.

    		hct-bp1qjwo61pqz3ahltv0mw

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		365F4154-92F6-4AE4-92F8-7FF34B540710

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectStatus.HealthCheckTemplateThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
    403Forbidden.HealthCheckTemplateAuthentication is failed for %s.Authentication is failed for %s.
    404ResourceNotFound.HealthCheckTemplateThe 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 timeSummary of changesOperation
    2024-01-24The Error code has changedView Change Details
    2024-01-18The Error code has changedView Change Details