租户端 网络 负载均衡（CLB） 负载均衡相关接口 DescribeLoadBalancers

DescribeLoadBalancers

最近更新时间: 2024-12-21 13:01:31

1. 接口描述

接口请求域名： clb.api3.gsesgpucloud.com。

查询一个地域的负载均衡实例列表

默认接口请求频率限制：20次/秒。

接口更新时间：2020-01-10 19:40:46。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeLoadBalancers
Version 是 否 String 公共参数，本接口取值：2018-03-17
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
LoadBalancerIds 否 否 Array of String 负载均衡实例ID。实例ID数量上限为20个。
示例值： ["lb-rbw5****"]
LoadBalancerType 否 否 String 负载均衡实例的网络类型：
OPEN：公网属性， INTERNAL：内网属性。
示例值： OPEN
Forward 否 否 Int64 负载均衡实例的类型。1：通用的负载均衡实例。如果不传此参数，则查询所有类型的负载均衡实例。
示例值： 1
LoadBalancerName 否 否 String 负载均衡实例的名称。
示例值： test_internal
Domain 否 否 String 腾讯云为负载均衡实例分配的域名。
示例值： lb-6m46rm32-se******o0q2g.clb.ap-guangzhou.testclb.com
LoadBalancerVips 否 否 Array of String 负载均衡实例的 VIP 地址，支持多个。
示例值： ["44.23.xxx.xxx"]
BackendPublicIps 否 否 Array of String 负载均衡绑定的后端服务的外网 IP。
示例值： ["102.23.xxx.xxx"]
BackendPrivateIps 否 否 Array of String 负载均衡绑定的后端服务的内网 IP。
示例值： ["172.16.xxx.xxx"]
Offset 否 否 Int64 数据偏移量，默认为 0。
示例值： 0
Limit 否 否 Int64 返回负载均衡实例的数量，默认为20，最大值为100。
示例值： 20
OrderBy 否 否 String 排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。LoadBalancerName表示lb实例名称，CreateTime表示创建时间，Domain表示域名，LoadBalancerType表示实例类型。
示例值： LoadBalancerName
OrderType 否 否 Int64 1：倒序，0：顺序，默认按照创建时间倒序。
示例值： 0
SearchKey 否 否 String 搜索字段，模糊匹配名称、域名、VIP。
示例值： test-name
ProjectId 否 否 Int64 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。
示例值： 1
WithRs 否 否 Int64 负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。
示例值： -1
VpcId 否 否 String 负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx。
示例值： vpc-bhqk****
SecurityGroup 否 否 String 安全组ID，如 sg-m1cc9123
示例值： sg-m1cc****
MasterZone 否 否 String 主可用区ID，如 ："100001" （对应的是广州一区）
示例值： 100001
Filters 否 否 Array of Filter 每次请求的Filters的上限为10，Filter.Values的上限为100。详细的过滤条件如下：
  •  internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。
  •  master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如 ："100001" （对应的是广州一区）。
  •  tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。

    • 示例值：查看

    3. 输出参数

    参数名称 类型 描述
    TotalCount Uint64 满足过滤条件的负载均衡实例总数。此数值与入参中的Limit无关。
    示例值： 0
    LoadBalancerSet LoadBalancer 返回的负载均衡实例数组。
    示例值：查看
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

    错误码 描述
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误
    InternalError 内部错误
    UnauthorizedOperation 未授权操作
    FailedOperation 操作失败
    InvalidParameter.FormatError 参数格式错误。
    InvalidParameterValue.Length 参数长度错误。
    InvalidParameterValue.InvalidFilter Filter参数输入错误。