You need to enable JavaScript to run this app.
导航
负载均衡
  • 文档首页
    • /
  • 负载均衡

DescribeListeners

最近更新时间：2024.03.22 08:27:45

首次发布时间：2021.08.31 10:37:27

我的收藏

调用 DescribeListeners 接口查询监听器列表。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填示例值
描述
ActionString是DescribeListeners要执行的操作，取值为DescribeListeners。
VersionString是2020-04-01API版本信息，当前版本为：2020-04-01。
LoadBalancerIdString否clb-bp1o94dp5i6ea****负载均衡实例ID。您可以调用DescribeLoadBalancers接口获取负载均衡实例ID。

ListenerIds.N

String

否

ListenerIds.1=lsn-2fek3rgsxhrsw5oxruwec&ListenerIds.2=lsn-2fel9ycnzz94w5oxruv8

监听器的ID。您可以调用本接口接口获取监听器ID。
参数 - N：表示监听器的序号。取值范围为1 ～ 100，表示指定监听器ID时最多可查询100个。

ListenerNameString否mylistener监听器的名称。
PageSizeInteger否20分页查询时每页的行数，取值范围为1 ～ 100，默认为10。
PageNumberInteger否1列表的页码，默认值为1。

TagFilters.N.Key

String

否

TagFilters.1.Key=k1&TagFilters.2.Key=k2

标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的监听器。
参数 - N：表示根据标签查询资源时标签键的序号，需按照数字顺序从1开始填写，取值范围为1～10。多个标签键之间使用&分隔。

TagFilters.N.Values.M

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3

标签的标签值。每个标签键最多可指定3个标签值。
参数 - M：表示根据标签查询资源时标签值的序号，需按照数字顺序从1开始填写，取值范围为1～3。多个标签值之间使用&分隔。

  • 未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的监听器。
  • 该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的监听器。
  • 同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联监听器的集合。

说明

如果传入该参数，则必须先传入TagFilters.N.Key。

返回参数

字段类型示例值
描述
RequestIdString20210811152539010225146063030****请求ID
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger50符合条件的监听器总数。
ListenersArray of Struct-符合条件的监听器的详细信息。具体请参见下表“ Listeners ”。

Listeners

字段类型示例值
描述
CreateTimeString2021-08-11T16:37:37Z监听器的创建时间。
UpdateTimeString2021-08-11T16:37:37Z监听器的最近操作时间。
ListenerIdStringlsn-2fek3rgsxhrsw5oxruwec****监听器的ID。
ListenerNameStringmylistener监听器的名称。

AclStatus

String

off

是否开启访问控制功能。

  • on：开启。
  • off ：不开启。

AclType

String

black

访问控制的方式。

  • white ：白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器不会转发任何请求。
  • black：黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器会转发全部请求。

说明

仅AclStatus参数为 on 时返回。

Bandwidth

Integer

10

监听器的带宽峰值，单位为Mbps。
返回为-1，表示监听器不指定限速。此时监听器的带宽峰值默认为CLB实例规格的剩余带宽。

AclIds

Array of String

["acl-2fe5excqgk6ww5oxruvcv****","acl-2febxt4pu0zy85oxruw0t****"]

监听器绑定的访问控制策略组ID。

说明

仅AclStatus参数为 on 时返回。

Protocol

String

TCP

监听器的协议。

  • TCP
  • UDP
  • HTTP
  • HTTPS

Scheduler

String

wrr

监听器使用的调度算法。

  • wrr：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。
  • wlc：加权最小连接数，在最少连接数的基础上，根据服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。
  • sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。

说明

该参数目前仅华南1（广州）、华东2（上海）地域返回，其他地域不返回。

ProxyProtocolType

String

off

是否启用PP协议。取值如下：

  • off：关闭。
  • standard：开启。

PersistenceType

String

off

会话保持的类型。

  • off：表示不启用会话保持。
  • source_ip：表示源地址IP。
  • insert：表示植入Cookie。
  • server：表示重写Cookie。
PersistenceTimeoutInteger10会话保持的超时时间，单位为秒。
CookieStringcookie123后端服务器配置的会话保持的Cookie名称。

Http2Enabled

String

off

HTTPS协议监听器是否开启前端HTTP 2.0协议。

  • on：开启。
  • off：不开启。

说明

TCP、UDP和HTTP协议监听器不返回该参数。

TagsArray of Struct-标签信息。具体请参见下表“Tags”。

ConnectionDrainEnabled

String

on

监听器是否开启连接优雅中断功能。

  • on：开启。
  • off：不开启。

说明

参数Protocol返回为HTTP或HTTPS时，该参数固定返回off。

ConnectionDrainTimeout

Integer

2

连接优雅中断的超时时间，单位为秒。

说明

参数ConnectionDrainEnabled返回为off时，该参数返回0。

PortInteger80监听器接收请求使用的端口。

Status

String

Active

监听器的状态。

  • Creating：创建中。
  • Active：运行中。
  • Deleting: 删除中。
  • Disabled: 已停用。

Enabled

String

off

是否启用监听器。

  • on：开启。
  • off：不开启。
ServerGroupIdStringrsp-bp1o94dp5i6ea****TCP/UDP监听器关联的后端服务器组的ID。HTTP/HTTPS监听器关联的默认后端服务器组ID。
CertificateIdStringcert-bp1o94dp5i6ea****HTTPS监听器关联的证书ID。
HealthCheckStruct-健康检查相关的参数，不同协议所需参数不同。具体请参见如下“ HealthCheck ”结构。

HealthCheck

字段类型示例值
描述

Enabled

String

off

监听器是否开启健康检查功能。

  • on ：开启。
  • off：不开启。

UdpRequest

String

Request123

执行健康检查的请求字符串。
仅当UDP监听器指定请求字符串时返回该参数。

UdpExpect

String

Expect123

健康检查的预期响应字符串。
仅当UDP监听器指定请求字符串时返回该参数。

IntervalInteger2执行健康检查的时间间隔。
TimeoutInteger2健康检查的响应超时时间，表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。
HealthyThresholdInteger3健康检查的健康阈值，表示连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
UnHealthyThresholdInteger3健康检查的不健康阈值，表示连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查“异常”。

Method

String

GET

监听器健康检查的方法。

  • GET：服务器需支持GET方法。
  • HEAD：服务器仅返回HEAD头部信息，可以降低后端开销，但要求服务器支持HEAD方法。

说明

TCP/UDP监听器不返回该参数。

Uri

String

/

健康检查的路径。

说明

TCP/UDP监听器不返回该参数。

Domain

String

www.test.com

健康检查的域名。

说明

TCP/UDP监听器不返回该参数。

HttpCode

String

http_2xx

健康检查正常的HTTP状态码。

  • http_2xx
  • http_3xx
  • http_4xx
  • http_5xx

说明

TCP/UDP监听器不返回该参数。

Tags

名称类型示例值描述
KeyStringk1标签的标签键。
ValueStringv1标签的标签值。

请求示例

GET /?Action=DescribeListeners&Version=2020-04-01&LoadBalancerId=clb-bp1o94dp5i6ea****&PageSize=20&PageNumber=1&ListenerIds.1=lsn-2fek3rgsxhrsw5oxr****&ListenerName=test HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeListeners",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },  
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "Listeners": [
        {
            "CreateTime": "2021-08-14T11:13:40Z",
            "UpdateTime": "2021-08-14T11:13:41Z",
            "ListenerId": "lsn-2fek3rgsxhrsw5oxr****",
            "ListenerName": "test",
            "AclStatus": "on",
            "AclType": "black",
            "Bandwidth": -1,
            "AclIds": [
                "acl-2fe5excqgk6ww5oxruvcv****",
                "acl-2febxt4pu0zy85oxruw0t****"
            ],
            "Enabled": "on",
            "Protocol": "HTTPS",
            "Scheduler": "wrr",
            "ProxyProtocolType": "off",
            "PersistenceType": "off",
            "PersistenceTimeut": 0,
            "ConnectionDrainEnabled": "off",
            "ConnectionDrainTimeout": 0,
            "Http2Enabled": "off",
            "Tags": [
                {
                    "Key": "k1",
                    "Value": "v1"
                },
                {
                    "Key": "k2",
                    "Value": ""
                }
            ],
            "Port": 3,
            "Status": "Active",
            "ServerGroupId": "rsp-bp1o94dp5i6ea****",
            "HealthCheck": {
                "Enabled": "on",
                "Interval": 12,
                "HealthyThreshold": 4,
                "UnHealthyThreshold": 5,
                "Timeout": 0
            }
          }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400InvalidName.MalformedThe specified Name is malformed.指定的 Name 参数格式不合法。
400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
400LimitExceeded.ListenerIdYou've reached the limit on the number of Listener that you can operate.已达到单次可操作 ListenerId 的资源数量上限。
400InvalidIncorrectOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified TagKey is malformed.指定的 TagKey 参数格式不合法。
400InvalidTagValue.MalformedThe specified TagValue is malformed.指定的 TagValue 参数格式不合法。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValuesYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签键值数量的上限。