All Products
Search

This Product

    Server Load Balancer:CreateHealthCheckTemplate

    Document Center

    Server Load Balancer:CreateHealthCheckTemplate

    Last Updated:Mar 01, 2024

    Creates a health check template in a region.

    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:CreateHealthCheckTemplateWrite
    • HealthCheckTemplate
      acs:alb:{#regionId}:{#accountId}:healthchecktemplate/*
      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 value of RequestId as the value of ClientToken. The request ID may be different for each request.
    		5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    HealthCheckTemplateNamestringYes

    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. If you set the value to 0, the port of a backend server is used for health checks.

    		80
    HealthCheckHoststringNo

    The domain name that you want to use for the health check.

    Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. The domain name must meet the following requirements:

    • The domain name can contain lowercase letters, digits, hyphens (-), and periods (.).
    • The domain name must contain at least one period (.) but cannot start or end with a period (.).
    • The rightmost domain label can contain only letters but cannot contain digits or hyphens (-).
    • Other fields cannot start or end with a hyphen (-).

    This parameter is required only if the HealthCheckProtocol parameter is set to HTTP.

    		$_ip
    HealthCheckCodesarrayNo

    The HTTP status codes that are used to indicate whether the backend server passes the health check.

    stringNo

    The HTTP status code that is used to indicate whether the backend server passes the health check.

    • If HealthCheckProtocol is set to HTTP, HealthCheckCodes can be set to http_2xx (default), http_3xx, http_4xx, and http_5xx. Separate multiple HTTP status codes with commas (,).
    • If HealthCheckProtocol is set to gRPC, HealthCheckCodes can be set to 0 to 99. Default value: 0. Value ranges are supported. You can enter up to 20 value ranges and separate them with commas (,).
    Note This parameter is available only if HealthCheckProtocol is set to HTTP or gRPC.
    		http_2xx,http_3xx
    HealthCheckIntervalintegerNo

    The interval at which health checks are performed.

    Valid values: 1 to 50.

    Default value: 2.

    		2
    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.

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

    The URL that is used for health checks.

    It must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). It can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/).

    Note This parameter is valid only if the HealthCheckProtocol parameter is set to HTTP.
    		/test/index.html
    HealthCheckMethodstringNo

    The method that you want to use for the health check. Valid values:

    • HEAD: By default, the ALB instance sends HEAD requests to a backend server to perform HTTP health checks.
    • POST: gRPC health checks automatically use the POST method.
    • GET: If the length of a response exceeds 8 KB, the response is truncated. However, the health check result is not affected.
    Note This parameter takes effect only when the HealthCheckProtocol parameter is set to HTTP or gRPC.
    		HEAD
    HealthCheckProtocolstringNo

    The protocol that you want to use for health checks. Valid values:

    • HTTP (default): To perform HTTP health checks, ALB sends HEAD or GET requests to a backend server to check whether the backend server is healthy.
    • TCP: To perform TCP health checks, ALB sends SYN packets to a backend server to check whether the port of the backend server is available to receive requests.
    • gRPC: To perform gRPC health checks, ALB sends 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: HTTP 1.0 and HTTP 1.1.

    Default value: HTTP 1.1.

    Note This parameter is valid only if the HealthCheckProtocol parameter is set to HTTP.
    		HTTP 1.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
    Tagobject []No

    The tags.

    KeystringNo

    The tag key. The tag key can be up to 128 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

    		env
    ValuestringNo

    The tag value. The tag value can be up to 128 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

    		product

    Response parameters

    ParameterTypeDescriptionExample
    object
    HealthCheckTemplateIdstring

    The ID of the health check template.

    		hct-1224334
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

    {
  "HealthCheckTemplateId": "hct-1224334",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400QuotaExceeded.HealthCheckTemplatesNumThe quota of %s is exceeded, usage %s/%s.The quota of %s is exceeded. Usage: %s/%s.

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

    Change history

    Change timeSummary of changesOperation
    2024-01-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      Added Error Codes: 403