Query CLB Instance Health Status

Last updated: 2019-11-29 16:59:05

    API Description

    This API (DescribeLBHealthStatus) is used to query the related parameters of health check for load balancer instances.

    Domain name for API access: lb.api.qcloud.com

    Request Parameters

    The following request parameter list only provides the API request parameters. Common request parameters are required when the API is called. The Action field for this API is DescribeLBHealthStatus.

    Parameter Name Required Type Description
    loadBalancerId Yes String ID of the load balancer instance, which can be queried via the API DescribeLoadBalancers.
    listenerId No String ID of the load balancer listener, which can be queried via the API DescribeLoadBalancerListeners.

    Response Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Successful; other values: Failed.
    message String Module error message description depending on API.
    codeDesc String Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned.
    data Array Returned array.

    Data is composed as follows:

    Parameter Name Type Description
    ip String Private IP of the CVM.
    protocol String Protocol.
    port Int CVM port.
    vport Int Listening port of the load balancer.
    healthStatus Int Health check result. 1: healthy; 0: unhealthy.

    Example

    Request

    https://lb.api.qcloud.com/v2/index.php?Action=DescribeLBHealthStatus
    &<Common request parameters>
    &loadBalancerId=lb-abcdefgh
    

    Response

    {
      "code":0,
      "message" : "",
      "codeDesc": "Success",
      "data":[
             {
                "ip":"10.2.3.0",
                "protocol":"TCP",
                "port":8001,
                "vport":8001,
                "healthStatus":0
             }
        ]
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help