获取监听器详情--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取监听器详情

最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 10:22:48

本接口用于获取监听器的详情。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=GetLB7Listener&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetLB7Listener`	接口名称。当前 API 的名称为 `GetLB7Listener`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
lb7_identity	String	是	`veew-lb79442102222490330****`	负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。
listener_identity	String	是	`res-121152522410110****`	监听器的 ID。您可以调用 ListLB7Listener 接口查询负载均衡实例下的监听器的 ID。

返回参数

参数	类型	示例值	描述
listener	Listener	`见下文说明`	监听器的信息。

Listener

参数	类型	示例值	描述
identity	String	`res-0294299501441299****`	监听器的 ID。
name	String	`listener-http`	监听器的名称。
listen_protocol	Integer	`1`	监听协议： 1：HTTP 2：HTTPS
listen_port	Integer	`80`	监听端口。
x_forwarded_for	Boolean	`true`	是否已开启“获取客户端IP”功能： true：已开启该功能。 false：未开启该功能。
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	`true`	是否已启用 HTTP/2： true：已启用。 false：未启用。

TlsStrategyMultiList

参数	类型	示例值	描述
version	String	`v1.0`	TLS 版本。
encrypt_algo_list	[]String	`ECDHE-ECDSA-AES128-SHA`	加密算法套件的列表。

请求示例

POST https://veenedge.volcengineapi.com/?Action=GetLB7Listener&Version=2021-04-30
{
    "lb7_identity": "veew-lb70204100444012074****",
    "listener_identity": "res-5210111041252969****"

}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406171530482BED1CD6CAE5DB01****",
        "Action": "GetLB7Listener",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "listener": {
            "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": 1718608685,
            "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
        }
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。