tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLoadBalancerOverview

Last updated: 2024-09-05 19:29:47

    1. API Description

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

    Queries the total number of CLB instances and the number of CLB instances in different status (running, isolated and about to expire).

    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: DescribeLoadBalancerOverview.
    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.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of CLB instances
    RunningCount Integer Number of CLB instances that are running
    IsolationCount Integer Number of CLB instances that are isolated
    WillExpireCount Integer Number of CLB instances that are about to expire
    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.

    4. Example

    Example1 Querying the number of CLB instances by the status

    This example shows you how to query the number of CLB instances by their status.

    Input Example

    https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancerOverview
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 0,
        "RunningCount": 0,
        "IsolationCount": 0,
        "WillExpireCount": 0,
        "RequestId": "03b18184-caf1-40d7-b01a-8a76565b94ad"
    }
}

    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
    DryRunOperation DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy