DescribeLoadBalancerTraffic

Last updated: 2021-11-16 16:53:08

    1. API Description

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

    This API is used to query CLB instances with high traffic under the current account, and return the top 10 results. For queries using a sub-account, only the CLB instances authorized to the sub-account will be returned.

    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 parameter. The value used for this API: DescribeLoadBalancerTraffic.
    Version Yes String Common parameter. The value used for this API: 2018-03-17.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    LoadBalancerRegion No String CLB instance region. If this parameter is not passed in, CLB instances in all regions will be returned.

    3. Output Parameters

    Parameter Name Type Description
    LoadBalancerTraffic Array of LoadBalancerTraffic Information of CLB instances sorted by outbound bandwidth from highest to lowest
    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 Querying CLB instances with high traffic

    Input Example

    https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancerTraffic
    &LoadBalancerRegion=ap-guangzhou
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "LoadBalancerTraffic": [
        {
          "LoadBalancerId": "lb-xxxxxx",
          "LoadBalancerName": "lb-name1",
          "Region": "ap-guangzhou",
          "Vip": "1.1.1.1",
          "OutBandwidth": 177.083
        },
        {
          "LoadBalancerId": "lb-kxyz2",
          "LoadBalancerName": "lb-xyzname",
          "Region": "ap-guangzhou",
          "Vip": "2.2.2.2",
          "OutBandwidth": 77.449
        }
      ],
      "RequestId": "03b18184-caf1-40d7-b01a-100010030712"
    }
    }
    

    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
    AuthFailure CAM signature/authentication error
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.