Tenant Cloud Network Cloud Load Balancer CLB APIs DescribeLoadBalancers

DescribeLoadBalancers

Last Updated At: 2026-08-02 00:05:23

1. Interface Description

Interface request domain name: clb.api3.convergecloud.com.

Query the list of CLB instances in a region

Default interface request rate limit: 20 times per second.

Interface update time: 2020-01-10 19:40:46.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeLoadBalancers
Version Yes No String Public parameter, The value of this interface: 2018-03-17
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
LoadBalancerIds No No Array of String CLB instance ID. There can be up to 20 IDs.
Example: ["lb-rbw5ji93"]
LoadBalancerType No No String CLB instance network type:
OPEN: Public network; INTERNAL: Private network.
Example: OPEN
Forward No No Int64 CLB instance type. 1: general CLB instance. If this parameter is not specified, all types of CLB instances will be queried.
Example: 1
LoadBalancerName No No String CLB instance name.
Example: lb_internal
Domain No No String Domain name assigned by the cloud platform for the CLB instance.
Example: lb-6m46rm32-seji93o0q2g.clb.ap-region1.com
LoadBalancerVips No No Array of String VIP address of a CLB instance (there can be multiple addresses).
Example: ["44.23.32.32"]
BackendPublicIps No No Array of String Public network IP of the real server bound to CLB.
Example: ["102.23.32.43"]
BackendPrivateIps No No Array of String Private network IP of the real server bound to CLB.
Example: ["172.16.76.87"]
Offset No No Int64 Data offset. Default: 0.
Example: 0
Limit No No Int64 Number of CLB instances returned. Default: 20. Maximum: 100.
Example: 20
OrderBy No No String Sorting parameter, supporting the following fields: LoadBalancerName, CreateTime, Domain, and LoadBalancerType. LoadBalancerName: LB instance name, CreateTime: creation time, Domain: domain name, LoadBalancerType: instance type.
Example: LoadBalancerName
OrderType No No Int64 1: Reverse; 0: Sequential. Default: reverse by creation time
Example: 0
SearchKey No No String Search field, supporting fuzzy match by name, domain, and VIP.
Example: lb-name
ProjectId No No Int64 The ID of the project to which the CLB instance belongs. This parameter can be obtained through the DescribeProject API.
Example: 1
WithRs No No Int64 Whether CLB is bound to a real server. 0: No; 1: Yes; -1: Query all.
Example: -1
VpcId No No String Unique ID of the VPC to which a CLB instance belongs, such as vpc-bhqkbhdx.
Example: vpc-bhqkji93
SecurityGroup No No String Security group ID, such as sg-m1cc9123
Example: sg-m1ccji93
MasterZone No No String Primary AZ ID. For example, "100001".
Example: 100001
Filters No No Array of Filter The maximum number of Filters per request is 10, and the maximum number of Filter.Values per request is 100. Detailed filter conditions are as follows:
  •  internet-charge-type - String - required: no - (filter condition) filter by CLB network billing mode, including "BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE".
  •  master-zone-id - String - required: no - (filter condition) filter by CLB primary AZ ID. For example, "100001".
  •  tag-key - String - required: no - (filter condition) filter by CLB tag key.

    • Example:View

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Total number of CLB instances that meet the filter conditions. This value is unrelated to the Limit parameter in the input.
    Example: 0
    LoadBalancerSet Array of LoadBalancer Returned CLB instance array.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameter Wrong parameter.
    InvalidParameterValue Incorrect parameter value
    InternalError Internal Error
    UnauthorizedOperation Unauthorized operation
    FailedOperation Failed to operate.
    InvalidParameter.FormatError Incorrect parameter format
    InvalidParameterValue.Length Invalid parameter length.
    InvalidParameterValue.InvalidFilter Filter parameter input error.