查询负载均衡实例列表

最近更新时间:2019-08-16 17:13:06

1. 接口描述

接口请求域名: clb.tencentcloudapi.com 。

查询负载均衡实例列表

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLoadBalancers
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerIds.N Array of String 负载均衡实例 ID。
LoadBalancerType String 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
Forward Integer 负载均衡实例的类型。1:通用的负载均衡实例,0:传统型负载均衡实例
LoadBalancerName String 负载均衡实例的名称。
Domain String 腾讯云为负载均衡实例分配的域名,本参数仅对传统型公网负载均衡才有意义。
LoadBalancerVips.N Array of String 负载均衡实例的 VIP 地址,支持多个。
BackendPublicIps.N Array of String 负载均衡绑定的后端服务的外网 IP。
BackendPrivateIps.N Array of String 负载均衡绑定的后端服务的内网 IP。
Offset Integer 数据偏移量,默认为 0。
Limit Integer 返回负载均衡实例的个数,默认为 20。
OrderBy String 排序参数,支持以下字段:LoadBalancerName,CreateTime,Domain,LoadBalancerType。
OrderType Integer 1:倒序,0:顺序,默认按照创建时间倒序。
SearchKey String 搜索字段,模糊匹配名称、域名、VIP。
ProjectId Integer 负载均衡实例所属的项目 ID,可以通过 DescribeProject 接口获取。
WithRs Integer 负载均衡是否绑定后端服务,0:没有绑定后端服务,1:绑定后端服务,-1:查询全部。
VpcId String 负载均衡实例所属私有网络,如 vpc-bhqkbhdx,
基础网络不支持通过VpcId查询。
SecurityGroup String 安全组ID,如 sg-m1cc9123
MasterZone String 主可用区ID,如 :"100001" (对应的是广州一区)

3. 输出参数

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

4. 示例

示例1 根据负载均衡实例ID来查询

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancers
&LoadBalancerIds.0=lb-rbw529fz
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "LoadBalancerSet": [
      {
        "LoadBalancerId": "lb-rbw529fz",
        "LoadBalancerName": "test_LB",
        "Forward": 1,
        "Domain": "",
        "LoadBalancerVips": [
          "129.226.78.67"
        ],
        "LoadBalancerType": "OPEN",
        "Status": 1,
        "CreateTime": "2019-07-02 18:12:52",
        "StatusTime": "2019-07-02 18:12:53",
        "ProjectId": 0,
        "OpenBgp": 0,
        "Snat": false,
        "Isolation": 0,
        "Log": "",
        "AnycastZone": "",
        "AddressIPVersion": "ipv4",
        "VpcId": "vpc-lt9uj4mo",
        "NumericalVpcId": 117008,
        "TargetRegionInfo": {
          "Region": "ap-hongkong",
          "VpcId": "vpc-lt9uj12o"
        },
        "SubnetId": "",
        "SecureGroups": [],
        "Tags": [],
        "VipIsp": "BGP",
        "MasterZone": null,
        "BackupZoneSet": null,
        "IsolatedTime": null,
        "ExpireTime": "2019-08-02 18:12:52",
        "ChargeType": "POSTPAID_BY_HOUR",
        "NetworkAttributes": {
          "InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
          "InternetMaxBandwidthOut": 10
        },
        "PrepaidAttributes": null
      }
    ],
    "RequestId": "eba822a4-67cb-414c-b21d-f98ba3995d12"
  }
}

示例2 根据负载均衡类型、所属项目、负载均衡名称、负载均衡实例的vip来查询

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancers
&LoadBalancerType=OPEN
&ProjectId=0
&LoadBalancerName=test_LB
&LoadBalancerVips.0=129.226.78.67
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "LoadBalancerSet": [
      {
        "LoadBalancerId": "lb-rbw529fz",
        "LoadBalancerName": "test_LB",
        "Forward": 1,
        "Domain": "",
        "LoadBalancerVips": [
          "129.226.78.67"
        ],
        "LoadBalancerType": "OPEN",
        "Status": 1,
        "CreateTime": "2019-07-02 18:12:52",
        "StatusTime": "2019-07-02 18:12:53",
        "ProjectId": 0,
        "OpenBgp": 0,
        "Snat": false,
        "Isolation": 0,
        "Log": "",
        "AnycastZone": "",
        "AddressIPVersion": "ipv4",
        "VpcId": "vpc-lt9uj4mo",
        "NumericalVpcId": 117008,
        "TargetRegionInfo": {
          "Region": "ap-hongkong",
          "VpcId": "vpc-lt9uj12o"
        },
        "SubnetId": "",
        "SecureGroups": [],
        "Tags": [],
        "VipIsp": "BGP",
        "MasterZone": null,
        "BackupZoneSet": null,
        "IsolatedTime": null,
        "ExpireTime": "2019-08-02 18:12:52",
        "ChargeType": "POSTPAID_BY_HOUR",
        "NetworkAttributes": {
          "InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
          "InternetMaxBandwidthOut": 10
        },
        "PrepaidAttributes": null
      }
    ],
    "RequestId": "eba822a4-67cb-414c-b21d-f98ba3995d12"
  }
}

示例3 查询后端绑定了指定内网IP的机器的负载均衡

查询绑定了内网IP为172.26.0.11的后端服务的负载均衡实例

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancers
&WithRs=1
&BackendPrivateIps.0=172.26.0.11
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 2,
    "LoadBalancerSet": [
      {
        "LoadBalancerId": "lb-rbw529fz",
        "LoadBalancerName": "test_LB",
        "Forward": 1,
        "Domain": "",
        "LoadBalancerVips": [
          "129.226.78.67"
        ],
        "LoadBalancerType": "OPEN",
        "Status": 1,
        "CreateTime": "2019-07-02 18:12:52",
        "StatusTime": "2019-07-02 18:12:53",
        "ProjectId": 0,
        "OpenBgp": 0,
        "Snat": false,
        "Isolation": 0,
        "Log": "",
        "AnycastZone": "",
        "AddressIPVersion": "ipv4",
        "VpcId": "vpc-lt9uj4mo",
        "NumericalVpcId": 117008,
        "TargetRegionInfo": {
          "Region": "ap-hongkong",
          "VpcId": "vpc-lt9uj12o"
        },
        "SubnetId": "",
        "SecureGroups": [],
        "Tags": [],
        "VipIsp": "BGP",
        "MasterZone": null,
        "BackupZoneSet": null,
        "IsolatedTime": null,
        "ExpireTime": "2019-08-02 18:12:52",
        "ChargeType": "POSTPAID_BY_HOUR",
        "NetworkAttributes": {
          "InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
          "InternetMaxBandwidthOut": 10
        },
        "PrepaidAttributes": null
      }
    ],
    "RequestId": "eba822a4-67cb-414c-b21d-f98ba3995d12"
  }
}

示例4 根据名称、域名、VIP多个字段模糊查询负载均衡实例

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancers
&SearchKey=test_LB
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "LoadBalancerSet": [
      {
        "LoadBalancerId": "lb-rbw529fz",
        "LoadBalancerName": "test_LB",
        "Forward": 1,
        "Domain": "",
        "LoadBalancerVips": [
          "129.226.78.67"
        ],
        "LoadBalancerType": "OPEN",
        "Status": 1,
        "CreateTime": "2019-07-02 18:12:52",
        "StatusTime": "2019-07-02 18:12:53",
        "ProjectId": 0,
        "OpenBgp": 0,
        "Snat": false,
        "Isolation": 0,
        "Log": "",
        "AnycastZone": "",
        "AddressIPVersion": "ipv4",
        "VpcId": "vpc-lt9uj4mo",
        "NumericalVpcId": 117008,
        "TargetRegionInfo": {
          "Region": "ap-hongkong",
          "VpcId": "vpc-lt9uj12o"
        },
        "SubnetId": "",
        "SecureGroups": [],
        "Tags": [],
        "VipIsp": "BGP",
        "MasterZone": null,
        "BackupZoneSet": null,
        "IsolatedTime": null,
        "ExpireTime": "2019-08-02 18:12:52",
        "ChargeType": "POSTPAID_BY_HOUR",
        "NetworkAttributes": {
          "InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
          "InternetMaxBandwidthOut": 10
        },
        "PrepaidAttributes": null
      }
    ],
    "RequestId": "eba822a4-67cb-414c-b21d-f98ba3995d12"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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