tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTargetHealth

Last updated: 2023-08-18 14:28:17

1. API Description

Domain name for API request: ecm.tencentcloudapi.com.

This API is used to get the health check status of a CLB real server.

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: DescribeTargetHealth.
Version Yes String Common Params. The value used for this API: 2019-07-19.
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.

3. Output Parameters

Parameter Name Type Description
LoadBalancers Array of LoadBalancerHealth List of CLB instances.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the health check status of CLB real server

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeTargetHealth
&LoadBalancerIds.0=lb-f9zyj3kb
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "040f094b-aed7-45fc-963a-ebae4970be44",
        "LoadBalancers": [
            {
                "LoadBalancerId": "lb-f9zyj3kb",
                "LoadBalancerName": "test",
                "Listeners": [
                    {
                        "Rules": [
                            {
                                "Targets": [
                                    {
                                        "HealthStatus": true,
                                        "HealthStatusDetail": "Alive",
                                        "IP": "172.16.0.67",
                                        "Port": 23001,
                                        "TargetId": "ein-ncnepgio"
                                    }
                                ]
                            }
                        ],
                        "ListenerId": "lbl-knd4jr8m",
                        "Port": 13001,
                        "Protocol": "TCP",
                        "ListenerName": ""
                    }
                ]
            }
        ]
    }
}

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
FailedOperation Operation failed.
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter.FormatError The parameter format is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameter.LBIdNotFound The CLB instance ID is incorrect.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
InvalidParameterValue.Length The parameter length is incorrect.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy