Domain name for API request: clb.tencentcloudapi.com.
This API (DescribeTargetHealth) is used to query the health check result of a real server of a CLB instance.
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: 2018-03-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
LoadBalancerIds.N | Yes | Array of String | List of IDs of CLB instances to be queried |
Parameter Name | Type | Description |
---|---|---|
LoadBalancers | Array of LoadBalancerHealth | CLB instance list Note: This field may return null , indicating that no valid values can be obtained. |
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: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetHealth
<Common request parameters>
{
"LoadBalancerIds": [
"lb-qc2iq5yc"
]
}
{
"Response": {
"LoadBalancers": [
{
"Listeners": [
{
"Rules": [
{
"Url": "/",
"Domain": "www.123.com",
"LocationId": "loc-5t7526km",
"Targets": []
}
],
"Port": 666,
"Protocol": "HTTP",
"ListenerId": "lbl-j36caqde",
"ListenerName": "http-111"
},
{
"Rules": [
{
"Url": null,
"Domain": null,
"LocationId": "loc-ewygg6i0",
"Targets": [
{
"HealthStatus": false,
"IP": "172.16.0.6",
"TargetId": "ins-19425500",
"Port": 2020
},
{
"HealthStatus": true,
"IP": "172.16.0.12",
"TargetId": "ins-19425y2y",
"Port": 80
}
]
}
],
"Port": 789,
"Protocol": "TCP",
"ListenerId": "lbl-fs9naq76",
"ListenerName": "tcp_test"
},
{
"Rules": [
{
"Url": "/",
"Domain": "www.456.com",
"LocationId": "loc-8gdc4qcq",
"Targets": []
}
],
"Port": 777,
"Protocol": "HTTP",
"ListenerId": "lbl-9nj07x0m",
"ListenerName": "http-222"
},
{
"Rules": [],
"Port": 1949,
"Protocol": "HTTPS",
"ListenerId": "lbl-087wrv48",
"ListenerName": "https-000"
}
],
"LoadBalancerName": "lb-test123",
"LoadBalancerId": "lb-qc2iq5yc"
}
],
"RequestId": "9d45e1ec-720c-4ce1-860e-e338e273e77e"
}
}
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 | Wrong parameter format. |
InvalidParameter.LBIdNotFound | Wrong CLB instance ID. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.Length | Wrong parameter length. |
UnauthorizedOperation | Unauthorized operation. |
UnsupportedOperation | Unsupported operation. |
本页内容是否解决了您的问题?