tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLBHealthStatus

Last updated: 2024-12-19 17:19:35

    API Description

    This API is used to query the health check parameters for CLB instances.
    Domain name for API calls: lb.api.qcloud.com

    Request Parameters

    The list below contains only the API request parameters. Common parameters should be added when you call the API. For more information, see Common Request Parameters. The Action field for this API is DescribeLBHealthStatus.
    Parameter
    Required
    Type
    Description
    loadBalancerId
    Yes
    String
    CLB instance ID, which can be queried via the DescribeLoadBalancers API.
    listenerId
    No
    String
    CLB listener ID, which can be queried via the DescribeLoadBalancerListeners API.

    Response Parameters

    Parameter
    Type
    Description
    code
    Int
    Common error code. 0: success; other values: failure. For more information, see Common Error Codes.
    message
    String
    API-related module error message description.
    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 structure of the data array:
    Parameter
    Type
    Description
    ip
    String
    Private IP of the CVM.
    protocol
    String
    Protocol.
    port
    Int
    Port of the CVM.
    vport
    Int
    Listening port of the CLB instance.
    healthStatus
    Int
    Health check result. 1: healthy; 0: unhealthy.

    Example

    Sample request
    https://lb.api.qcloud.com/v2/index.php?Action=DescribeLBHealthStatus
    &loadBalancerId=lb-abcdefgh
    Sample response
    {
      "code":0,
      "message" : "",
      "codeDesc": "Success",
      "data":[
             {
                "ip":"10.2.3.0",
                "protocol":"TCP",
                "port":8001,
                "vport":8001,
                "healthStatus":0
             }
        ]
    }
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy