本接口用于获取负载均衡实例关联的监听器的列表。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数，请参见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListLB7Listener | 接口名称。当前 API 的名称为 ListLB7Listener。 |
| Version | String | 是 | 2021-04-30 | 接口版本。当前 API 的版本为 2021-04-30。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| lb7_identity | String | 是 | veew-lb79442102222490330**** | 负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。 |
| listener_name | String | 否 | listener-http | 监听器的名称。支持模糊查询。 |
| pagination | Pagination | 否 | 见下文说明 | 分页查询配置。 |
| listener_identity | String | 否 | res-4044414421464414**** | 监听器的 ID。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
page | Integer | 否 |
| 监听器列表的页码。 |
limit | Integer | 否 |
| 分页查询时设置的每页行数。 |
order_by | Integer | 否 |
| 查询出来的监听器的排列顺序，按照创建时间排序。取值范围：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| listeners | []Listeners | 见下文说明 | 监听器的信息。 |
| total_count | Long | 2 | 监听器的数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| identity | String | res-0294299501441299**** | 监听器的 ID。 |
| name | String | listener-http | 监听器的名称。 |
listen_protocol | Integer |
| 监听协议：
|
| listen_port | Integer | 80 | 监听端口。 |
x_forwarded_for | Boolean |
| 是否已开启“获取客户端IP”功能：
|
| redirect_to | String | res-009403001830032**** | 重定向到的目标监听器的 ID。 |
| idle_timeout | Integer | 60 | 空闲超时时间。单位：秒。 |
| request_timeout | Integer | 60 | 请求超时时间。单位：秒。 |
| desc | String | listener_01 | 监听器的描述。 |
| create_time | Long | 1635327375 | 监听器的创建时间，以 UNIX 时间戳格式显示。单位：秒。 |
| update_time | Long | 1635327375 | 监听器的更新时间，以 UNIX 时间戳格式显示。单位：秒。 |
| redirect_to_name | String | https01 | 重定向到的目标监听器的名称。 |
| tls_strategy_multi_list | []TlsStrategyMultiList | 见下文说明 | TLS 安全策略列表。 |
http2_enabled | Boolean |
| 是否已启用 HTTP/2：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| version | String | v1.0 | TLS 版本。 |
| encrypt_algo_list | []String | ECDHE-ECDSA-AES128-SHA | 加密算法套件的列表。 |
POST https://veenedge.volcengineapi.com/?Action=ListLB7Listener&Version=2021-04-30
{
"lb7_identity": "veew-lb79442102222490330****"
}
{
"ResponseMetadata": {
"RequestId": "2024061715085199CF4CDDF4BC3600****",
"Action": "ListLB7Listener",
"Version": "2021-04-30",
"Service": "veenedge",
"Region": "cn-north-1"
},
"Result": {
"listeners": [
{
"identity": "res-4044414421464414****",
"name": "listener-http",
"listen_protocol": 1,
"listen_port": 80,
"x_forwarded_for": true,
"redirect_to": "res-5210111041252969****",
"tls_strategy": null,
"idle_timeout": 60,
"request_timeout": 60,
"response_timeout": 0,
"desc": "",
"create_time": 1718352845,
"update_time": 1718607272,
"redirect_to_name": null,
"tls_strategy_multi_list": null,
"http2_enabled": false,
"quic_enabled": false,
"proxy_buffer_size": 0
},
{
"identity": "res-5210111041252969****",
"name": "listener-https",
"listen_protocol": 2,
"listen_port": 443,
"x_forwarded_for": true,
"redirect_to": "",
"tls_strategy": null,
"idle_timeout": 60,
"request_timeout": 60,
"response_timeout": 0,
"desc": "listener-https-01",
"create_time": 1718351839,
"update_time": 1718607565,
"redirect_to_name": null,
"tls_strategy_multi_list": [
{
"version": "v1.0",
"encrypt_algo_list": [
"ECDHE-ECDSA-AES128-SHA"
]
}
],
"http2_enabled": true,
"quic_enabled": false,
"proxy_buffer_size": 0
}
],
"total_count": 2
}
}
如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。