文档中心 黑石负载均衡 API 文档 七层流量镜像相关接口 获取流量镜像的监听器列表信息

获取流量镜像的监听器列表信息

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

1. 接口描述

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

获取流量镜像的监听器列表信息。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTrafficMirrorListeners
Version String 公共参数,本接口取值:2018-06-25
Region String 公共参数,本接口不需要传递此参数。
TrafficMirrorId String 流量镜像实例ID。
Offset Integer 分页的偏移量,也即从第几条记录开始查询
Limit Integer 单次查询返回的条目数,默认值:500。
SearchLoadBalancerIds.N Array of String 待搜索的负载均衡Id。
SearchLoadBalancerNames.N Array of String 待搜索的负载均衡名称。
SearchVips.N Array of String 待搜索的Vip。
SearchListenerIds.N Array of String 待搜索的监听器ID。
SearchListenerNames.N Array of String 待搜索的监听器名称。
SearchProtocols.N Array of String 待搜索的协议名称。
SearchLoadBalancerPorts.N Array of Integer 待搜索的端口。

3. 输出参数

参数名称 类型 描述
ListenerSet Array of TrafficMirrorListener 监听器列表。
TotalCount Integer 监听器总数。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取流量镜像的监听器列表信息

输入示例

https://bmlb.tencentcloudapi.com/?Action=DescribeTrafficMirrorListeners
&TrafficMirrorId=bmtm-lmep0eit
&<公共请求参数>

输出示例

{
  "Response": {
    "ListenerSet": [
      {
        "ListenerId": "lbl-3b8kycav",
        "ListenerName": "http",
        "Protocol": "http",
        "LoadBalancerPort": 80,
        "Bandwidth": 0,
        "MaxBandwidth": 0,
        "ListenerType": "L7Listener",
        "SSLMode": 0,
        "CertId": "",
        "CertCaId": "",
        "Status": 1,
        "AddTimestamp": "2018-10-11 15:29:42",
        "LoadBalancerId": "lb-gdr96fc7",
        "VpcName": "cassiehe",
        "VpcCidrBlock": "10.1.0.0/16",
        "LoadBalancerVips": [
          "115.159.240.85"
        ],
        "LoadBalancerName": "5c1-LB",
        "BindTrafficMirror": 0
      }
    ],
    "TotalCount": 1,
    "RequestId": "ac1bf674-f4d9-421e-ac50-de1f46c40238"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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