当前位置：主页 > 查看内容

负载均衡 查询负载均衡详细信息 - API 文档

发布时间：2021-09-23 00:00| 有 位朋友查看

简介：1. 接口描述 接口请求域名： clb.tencentcloudapi.com 。 查询负载均衡的详细信息，包括监听器，规则及后端目标。 默认接口请求频率限制：20次/秒。 注意：本接口支持金融区地域。由于金融区和非金融区是隔离不互通的，因此当公共参数 Region 为金融区地域（……

1. 接口描述

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

查询负载均衡的详细信息，包括监听器，规则及后端目标。

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeLoadBalancersDetail。
Version 是 String 公共参数，本接口取值：2018-03-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
Limit 否 Integer 返回负载均衡列表数目，默认20，最大值100。
Offset 否 Integer 返回负载均衡列表起始偏移量，默认0。
Fields.N 否 Array of String 选择返回的Fields列表，默认添加LoadBalancerId和LoadBalancerName。
TargetType 否 String 当Fields包含TargetId、TargetAddress、TargetPort、TargetWeight等Fields时，必选选择导出目标组的Target或者非目标组Target，值范围NODE、GROUP。
Filters.N 否 Array of Filter 查询负载均衡详细信息列表条件，详细的过滤条件如下：
  • loadbalancer-id - String - 是否必填：否 - （过滤条件）按照 负载均衡ID 过滤，如："lb-12345678"。
  • project-id - String - 是否必填：否 - （过滤条件）按照 项目ID 过滤，如："0","123"。
  • network - String - 是否必填：否 - （过滤条件）按照 负载均衡网络类型 过滤，如："Public","Private"。
  • vip - String - 是否必填：否 - （过滤条件）按照 负载均衡Vip 过滤，如："1.1.1.1","2204::22:3"。
  • target-ip - String - 是否必填：否 - （过滤条件）按照 后端目标内网Ip 过滤，如："1.1.1.1","2203::214:4"。
  • vpcid - String - 是否必填：否 - （过滤条件）按照 负载均衡所属vpcId 过滤，如："vpc-12345678"。
  • zone - String - 是否必填：否 - （过滤条件）按照 负载均衡所属的可用区 过滤，如："ap-guangzhou-1"。
  • tag-key - String - 是否必填：否 - （过滤条件）按照 负载均衡标签的标签键 过滤，如："name"。
  • tag:* - String - 是否必填：否 - （过滤条件）按照 负载均衡的标签 过滤，':' 后面跟的是标签键。如：过滤标签键name，标签值zhangsan,lisi，{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。
  • fuzzy-search - String - 是否必填：否 - （过滤条件）按照 负载均衡Vip，负载均衡名称 模糊搜索，如："1.1"。
    		•

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 负载均衡详情列表总数。
    LoadBalancerDetailSet Array of LoadBalancerDetail 负载均衡详情列表。
    注意：此字段可能返回 null，表示取不到有效值。
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询负载均衡详细信息

    输入示例

    https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancersDetail
&Offset=0
&Limit=20
&<公共请求参数>

    输出示例

    {
  "Response": {
    "TotalCount": 0,
    "LoadBalancerDetailSet": [],
    "RequestId": "d09b91ba-a81e-4ca3-b423-c64e60127c64"
  }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

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

    • Tencent Cloud SDK 3.0 for Python
    • Tencent Cloud SDK 3.0 for Java
    • Tencent Cloud SDK 3.0 for PHP
    • Tencent Cloud SDK 3.0 for Go
    • Tencent Cloud SDK 3.0 for NodeJS
    • Tencent Cloud SDK 3.0 for .NET
    • Tencent Cloud SDK 3.0 for C++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

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

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

    本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！
    上一篇：同步节点信息_云容器引擎 CCE_用户指南_节点管理 下一篇：没有了

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐