调用 DescribeListeners 接口,查询满足指定条件的监听器。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeListeners | 要执行的操作,取值为DescribeListeners。 |
Version | String | 是 | 2020-04-01 | API版本信息,当前版本为:2020-04-01。 |
LoadBalancerId | String | 否 | clb-bp1o94dp5i6ea**** | 负载均衡实例ID。 |
ListenerIds.N | String | 否 | ListenerIds.1=lsn-2fek3rgsxhrsw5oxr**** | 监听器的ID。
|
ListenerName | String | 否 | mylistener | 监听器的名称。 |
TagFilters.N.Key | String | 否 | TagFilters.1.Key=k1&TagFilters.2.Key=k2 | 标签的标签键。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3 | 标签的标签值。
说明
|
PageNumber | Integer | 否 | 1 | 列表的页码,默认值为1。 |
PageSize | Integer | 否 | 20 | 分页查询时每页的行数,取值范围为1 ~ 100,默认为10。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 20210811152539010225146063030**** | 请求ID |
TotalCount | Integer | 50 | 符合条件的监听器总数。 |
PageNumber | Integer | 1 | 当前页码。 |
PageSize | Integer | 20 | 当前分页的行数。 |
Listeners | Array of Struct | - | 符合条件的监听器的详细信息。具体请参见下表“ Listeners ”。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ListenerId | String | lsn-2fek3rgsxhrsw5oxruwec**** | 监听器的ID。 |
ListenerName | String | listener-1 | 监听器的名称。 |
Description | String | mylistener | 监听器的描述。 |
Protocol | String | TCP | 监听器的协议。
|
Port | Integer | 80 | 监听器接收请求使用的端口。 |
Scheduler | String | wrr | 监听器使用的调度算法。
|
Bandwidth | Integer | 10 | 监听器的带宽峰值,单位为Mbps。 |
ServerGroupId | String | rsp-bp1o94dp5i6ea**** | TCP/UDP监听器关联的后端服务器组的ID。HTTP/HTTPS监听器关联的默认后端服务器组ID。 |
CertificateId | String | cert-bp1o94dp5i6ea**** | HTTPS监听器关联的证书ID。 |
HealthCheck | Struct | - | 健康检查相关的参数,不同协议所需参数不同。具体请参见如下“ HealthCheck ”结构。 |
AclStatus | String | off | 是否开启访问控制功能。
|
AclType | String | black | 访问控制的方式。
说明 仅 |
AclIds | Array of String | ["acl-2fe5excqgk6ww5oxruvcv****","acl-2febxt4pu0zy85oxruw0t****"] | 监听器绑定的访问控制策略组ID。 说明 仅 |
ProxyProtocolType | String | off | 是否启用PP协议。取值如下:
|
PersistenceType | String | off | 会话保持的类型。
|
PersistenceTimeout | Integer | 10 | 会话保持的超时时间,单位为秒。 |
Cookie | String | cookie123 | 后端服务器配置的会话保持的Cookie名称。 |
ClientHeaderTimeout | Integer | 60 | 读取客户端请求头的超时时间。客户端向CLB发起请求,若在超时时间内客户端没有传输整个报头,CLB将返回408错误码给客户端,表示请求超时。 |
ClientBodyTimeout | Integer | 60 | 读取客户端请求正文的超时时间。客户端向CLB发起请求,若在超时时间内客户端没有发送任何请求体,CLB将返回408错误码给客户端,表示请求超时。
|
KeepaliveTimeout | Integer | 60 | 客户端与CLB之间的长连接超时时间。若在超时时间内一直没有访问请求,CLB会中断当前连接,直到下一次请求到来时重新建立新的连接。
|
ProxyConnectTimeout | Integer | 60 | CLB与后端服务器之间的连接建立超时时间。若超时时间内CLB与后端服务器连接未建立,则终止建立连接操作。 |
ProxySendTimeout | Integer | 60 | CLB将请求传输到后端服务器的超时时间。CLB向后端服务器发起请求,若后端服务器在超时时间内未收到任何内容,则会关闭此连接。
|
ProxyReadTimeout | Integer | 60 | CLB从后端服务器读取响应的超时时间。CLB向后端服务器发起请求,若超时时间内接收请求的后端服务器无响应,则会关闭此连接。
|
SendTimeout | Integer | 60 | CLB向客户端发送响应的超时时间。CLB向客户端发送响应,若客户端在超时时间内未收到任何内容,则连接会被关闭。
|
SecurityPolicyId | String | default_policy | HTTPS监听器的TLS安全策略。仅HTTPS监听器返回此参数。
说明
|
Http2Enabled | String | off | HTTPS协议监听器是否开启前端HTTP 2.0协议。
说明 TCP、UDP和HTTP协议监听器不返回该参数。 |
ConnectionDrainEnabled | String | on | 监听器是否开启连接优雅中断功能。
说明 参数 |
ConnectionDrainTimeout | Integer | 2 | 连接优雅中断的超时时间,单位为秒。 说明 参数 |
Status | String | Active | 监听器的状态。
|
Enabled | String | off | 是否启用监听器。
|
Tags | Array of Struct | - | 标签信息。具体请参见下表“Tags”。 |
CreateTime | String | 2021-08-11T16:37:37Z | 监听器的创建时间。 |
UpdateTime | String | 2021-08-11T16:37:37Z | 监听器的最近操作时间。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Enabled | String | off | 监听器是否开启健康检查功能。
|
UdpRequest | String | Request123 | 执行健康检查的请求字符串。 |
UdpExpect | String | Expect123 | 健康检查的预期响应字符串。 |
Interval | Integer | 2 | 执行健康检查的时间间隔。 |
Timeout | Integer | 2 | 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查异常。 |
HealthyThreshold | Integer | 3 | 健康检查的健康阈值,表示连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。 |
UnHealthyThreshold | Integer | 3 | 健康检查的不健康阈值,表示连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查“异常”。 |
Method | String | GET | 监听器健康检查的方法。
说明 TCP/UDP监听器不返回该参数。 |
Uri | String | / | 健康检查的路径。 说明 TCP/UDP监听器不返回该参数。 |
Domain | String | www.test.com | 健康检查的域名。 说明 TCP/UDP监听器不返回该参数。 |
HttpCode | String | http_2xx | 健康检查正常的HTTP状态码。
说明 TCP/UDP监听器不返回该参数。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | k1 | 标签的标签键。 |
Value | String | v1 | 标签的标签值。 |
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****", "TotalCount": 1, "PageNumber": 1, "PageSize": 20, "Listeners": [ { "ListenerId": "lsn-2fek3rgsxhrsw5oxr****", "ListenerName": "test", "Protocol": "HTTPS", "Scheduler": "wrr", "Port": 3, "AclStatus": "on", "AclType": "black", "Bandwidth": -1, "ServerGroupId": "rsp-bp1o94dp5i6ea****", "CertificateId": "cert-bp1o94dp5i6ea****", "HealthCheck": { "Enabled": "on", "Interval": 12, "Timeout": 0 "HealthyThreshold": 4, "UnHealthyThreshold": 5, "Method": "GET", "Uri": "/", "Domain": "www.test.com", "HttpCode": "http_2xx", }, "AclIds": [ "acl-2fe5excqgk6ww5oxruvcv****", "acl-2febxt4pu0zy85oxruw0t****" ], "ProxyProtocolType": "off", "PersistenceType": "off", "PersistenceTimeut": 0, "Http2Enabled": "off", "ConnectionDrainEnabled": "off", "ConnectionDrainTimeout": 0, "Status": "Active", "Enabled": "on", "Tags": [ { "Key": "k1", "Value": "v1" }, { "Key": "k2", "Value": "" } ], "CreateTime": "2021-08-14T11:13:40Z", "UpdateTime": "2021-08-14T11:13:41Z", } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidName.Malformed | The specified Name is malformed. | 指定的 Name 参数格式不合法。 |
400 | InvalidPaging.Malformed | The specified PageNumber or PageSize is malformed. | 指定的分页参数格式不合法。 |
400 | LimitExceeded.ListenerId | You've reached the limit on the number of Listener that you can operate. | 已达到单次可操作 ListenerId 的资源数量上限。 |
400 | InvalidIncorrectOrder.Malformed | The specified index order is malformed. | 指定的索引顺序参数格式不合法。 |
400 | InvalidTagKey.Malformed | The specified TagKey is malformed. | 指定的 TagKey 参数格式不合法。 |
400 | InvalidTagValue.Malformed | The specified TagValue is malformed. | 指定的 TagValue 参数格式不合法。 |
400 | LimitExceeded.TagFilterKey | You've reached the limit on the number of tag keys that you can filter. | 已达到单次可指定过滤标签键数量的上限。 |
400 | LimitExceeded.TagFilterValues | You've reached the limit on the number of tag values that you can filter. | 已达到单次可指定过滤标签键值数量的上限。 |