Domain name for API request: clb.intl.tencentcloudapi.com.
This API (DescribeTargetHealth) is used to query the health check result of a real server of a CLB instance. It is not supported by Classic CLB.
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: DescribeTargetHealth. |
| Version | Yes | String | Common Params. The value used for this API: 2023-04-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| LoadBalancerIds.N | Yes | Array of String | List of CLB instance IDs to query. |
| ListenerIds.N | No | Array of String | Listener ID list to query. |
| LocationIds.N | No | Array of String | List of forwarding rule IDs to query. |
| Parameter Name | Type | Description |
|---|---|---|
| LoadBalancers | Array of LoadBalancerHealth | LoadBalancer list. |
| 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. |
Querying the Backend Health Status of a CLB Instance
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetHealth
<Common request parameters>
{
"LoadBalancerIds": [
"lb-qc2iq5yc"
]
}
{
"Response": {
"LoadBalancers": [
{
"LoadBalancerId": "lb-xxxxxxxx",
"LoadBalancerName": "HEALTHCHK-LISTENER",
"Listeners": [
{
"ListenerId": "lbl-xxxxxxxx",
"ListenerName": "80",
"Protocol": "HTTP",
"Port": 80,
"Rules": [
{
"LocationId": "loc-xxxxxxxx",
"Domain": "kq.xxxxxx.com.cn",
"Url": "/healthchk",
"Targets": [
{
"TargetId": "cvm-xxxxxxxx",
"IP": "x.x.x.x",
"Port": 80,
"HealthStatus": true,
"HealthStatusDetail": "Alive"
}
]
}
]
}
]
}
],
"RequestId": "e3a60a20-d994-48d6-b971-3bd05aa1aae6"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| InvalidParameter.LBIdNotFound | CLB instance ID error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.Length | Invalid parameter length. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | The operation is not supported. |
フィードバック