Domain name for API request: alb.intl.tencentcloudapi.com.
This API is used to query the health check template list.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeHealthCheckTemplates. |
| 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. |
| Filters.N | No | Array of Filter | Filter. Query health check templates by specifying filter criteria. Supported:
|
| HealthCheckTemplateIds.N | No | Array of String | Health check template ID list. The ID format is hct- followed by alphanumeric characters. |
| MaxResults | No | String | The number of returned lists. Default value: 20. Maximum value: 100. |
| NextToken | No | String | Token for the next query. Not required for the first query or when there is no next query. |
| Parameter Name | Type | Description |
|---|---|---|
| HealthCheckTemplates | Array of HealthCheckTemplate | Health check template list. |
| NextToken | String | Token for the next query. If the current page is the last page, this field returns empty. |
| TotalCount | Integer | Total number of health check templates queried after filtering. |
| 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. |
POST / HTTP/1.1
Host: alb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHealthCheckTemplates
<Common request parameters>
{
"HealthCheckTemplateIds": [
"hct-m4x8q2pa"
],
"MaxResults": "20"
}{
"Response": {
"HealthCheckTemplates": [
{
"HealthCheckCodes": [
"http_1xx"
],
"HealthCheckHealthyThreshold": 2,
"HealthCheckHost": "example.com",
"HealthCheckHttpVersion": "HTTP1.1",
"HealthCheckInterval": 10,
"HealthCheckMethod": "GET",
"HealthCheckPath": "/hello/index.html",
"HealthCheckPort": 80,
"HealthCheckProtocol": "HTTP",
"HealthCheckTemplateId": "hct-m4x8q2pa",
"HealthCheckTemplateName": "target-group-health-check",
"CreateTime": "2025-01-01T08:30:00+08:00",
"ModifyTime": "2025-01-01T08:30:00+08:00",
"HealthCheckTimeout": 2,
"HealthCheckUnhealthyThreshold": 2,
"Tags": [
{
"TagKey": "key-xxx",
"TagValue": "value-xxx"
}
]
}
],
"NextToken": "3974ae26e***",
"TotalCount": 1,
"RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
フィードバック