tencent cloud

APIs

DokumentasiAPIsApplication Load BalancerHealth Check Template APIsModifyHealthCheckTemplate

ModifyHealthCheckTemplate

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-28 14:18:05

1. API Description

Domain name for API request: alb.intl.tencentcloudapi.com.

Modify a health check template

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyHealthCheckTemplate.
Version Yes String Common Params. The value used for this API: 2025-10-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
HealthCheckTemplateId Yes String

Health check template ID. The format is hct- followed by alphanumeric characters.
DryRun No Boolean

Whether to preview this request.

  • false (default): Send a normal request to directly modify the health check template.
  • true: Send a preview request to check whether the parameters, format, and service limits of the modified health check template meet the requirements.
HealthCheckCodes.N No Array of String

Health check status code. Value:

  • When the health check protocol is HTTP/HTTPS:
    • HTTP_1xx
    • HTTP_2xx (default value)
    • HTTP_3xx
    • HTTP_4xx
    • HTTP_5xx
  • When the health check protocol is GRPC/GRPCS: the default value is 12, the value range is 0-99, and the input value can be a numerical value, multiple values, a range, or a combination, for example:
    • "20"
    • "0-99"
HealthCheckHealthyThreshold No Integer

Threshold for determining backend service health. After the health check succeeds consecutively for this number of times, the backend service status changes from unhealthy to healthy.
Value range: 2-10.
Default value: 2.
HealthCheckHost No String

Health check domain name.
Length limit: 1-255 characters.
It can contain lowercase letters, digits, dashes (-), and half-width periods (.).

This parameter takes effect only when HealthCheckProtocol is set to HTTP/HTTPS/GRPC/GRPCS.
HealthCheckHttpVersion No String

HTTP version for health check. Valid values:

  • HTTP1.1 (default)
  • HTTP1.0

    This parameter takes effect only when HealthCheckProtocol is set to HTTP or HTTPS.
HealthCheckInterval No Integer

The interval of health check. Unit: second. Value range: 2-300. Default value: 5.
HealthCheckMethod No String

Health check method. Value: - GET - HEAD (default value)

This parameter takes effect only when HealthCheckProtocol is set to HTTP or HTTPS.
HealthCheckPath No String

Forwarding rule path for health check. The length is 1-80 characters. Only letters, digits, characters -/.%?#&=, and extended characters _;~!（)*[]@$^:',+ can be used. The URL must start with a forward slash (/).

The forwarding rule path parameter takes effect only when HealthCheckProtocol is HTTP/HTTPS/GRPC/GRPCS.
HealthCheckPort No Integer

Health check access to the backend server port. Value range: 0-65535. Default value: 0, which means the backend server port.
HealthCheckProtocol No String

Health check protocol. Valid values:

  • HTTP (default): Sends HEAD or GET requests to simulate browser access requests and check whether the server application is healthy.
  • HTTPS: Sends HEAD or GET requests to simulate browser access requests and check whether the server application is healthy. (Encrypts data and is more secure than HTTP.)
  • TCP: Sends SYN handshake messages to detect whether the server port is alive.
  • GRPC: Sends POST or GET requests to check whether the server application is healthy.
  • GRPCS: Sends POST or GET requests to check whether the server application is healthy.
HealthCheckTemplateName No String

Health check template name. It is 1-255 characters long and can contain digits, upper- and lower-case letters, Chinese characters, half-width periods (.), underscores (_), and dashes (-).
HealthCheckTimeout No Integer

Health check response timeout, in seconds.
Value range: 2-60.
Default value: 2.
HealthCheckUnhealthyThreshold No Integer

Threshold for determining an unhealthy backend service. After how many consecutive health check failures, the backend service status changes from healthy to unhealthy.
Value range: 2-10.
Default value: 2.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modify the name of a health check template

Input Example

POST / HTTP/1.1
Host: alb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyHealthCheckTemplate
<Common request parameters>

{
    "HealthCheckTemplateId": "hct-fb7tuf7o",
    "HealthCheckTemplateName": "Modify name"
}

Output Example

{
    "Response": {
        "RequestId": "e109ac6e-a12b-4fb2-885e-e63d63c4d883"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
DryRunOperation DryRun operation means the request will be successful, but the DryRun parameter is passed.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Parameters are missing.
OperationDenied Operation denied.
RegionError Region error
RequestLimitExceeded Number of requests exceeds the frequency limit.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resources are unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation The operation is not supported.
Topik sebelumnya: ModifyLoadBalancerAttributesTopik selanjutnya: DescribeHealthCheckTemplates

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan

Search
    Enter keywords to search documentation