文档中心 黑石负载均衡 API 文档 四层负载均衡相关接口 获取黑石负载均衡四层监听器绑定的主机列表

获取黑石负载均衡四层监听器绑定的主机列表

最近更新时间:2019-07-24 15:02:22

1. 接口描述

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

获取黑石负载均衡四层监听器绑定的主机列表。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeL4Backends
Version String 公共参数,本接口取值:2018-06-25
Region String 公共参数,本接口不需要传递此参数。
LoadBalancerId String 负载均衡实例ID,可通过接口DescribeLoadBalancers查询。
ListenerId String 负载均衡四层监听器ID,可通过接口DescribeL4Listeners查询。
BackendSet.N Array of DescribeL4Backend 待查询的主机信息。

3. 输出参数

参数名称 类型 描述
BackendSet Array of L4Backend 返回的绑定关系列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取黑石负载均衡四层监听器绑定的主机列表

输入示例

https://bmlb.tencentcloudapi.com/?Action=DescribeL4Backends
&LoadBalancerId=lb-dyxceyv5
&ListenerId=lbl-i4go349z
&<公共请求参数>

输出示例

{
  "Response": {
    "BackendSet": [
      {
        "BindType": 0,
        "Port": 5000,
        "Weight": 100,
        "Status": "Dead",
        "InstanceId": "cpm-bujx6q9x",
        "Alias": "测试机器",
        "LanIp": "10.10.1.3",
        "Operates": [
          "modifyDeviceAlias",
          "renewDevice",
          "shutdownDevice",
          "rebootDevice",
          "reloadDeviceOs",
          "resetPasswd",
          "bindEip",
          "unbindEip",
          "isolateDevice",
          "bindLb",
          "unbindLb",
          "offlineDevice",
          "runUserCmd",
          "changeLanIp",
          "CreateCustomImage",
          "bareMetalMigration"
        ],
        "ProbePort": -1
      }
    ],
    "RequestId": "d401377c-ac68-48ad-ac06-f7d0ca4e4ff6"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在